Skip to content

Commit 8a43979

Browse files
committed
Examples for analysis command options
1 parent 6dacb85 commit 8a43979

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

COMMANDS.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,42 @@ a profile, the newest versions will be used. Profiles are scripts that can be fo
6464
- Use your own initial Neo4j password
6565
- For more details have a look at the script [analyze.sh](./scripts/analysis/analyze.sh)
6666

67+
### Examples
68+
69+
#### Start an analysis with CSV reports only
70+
71+
If only the CSV reports are needed, that are the result of Cypher queries and don't need any further dependencies (like Python)
72+
the analysis can be speeded up with:
73+
74+
```shell
75+
./../../scripts/analysis/analyze.sh --report Csv
76+
```
77+
78+
#### Start an analysis with Jupyter reports only
79+
80+
If only the Jupyter reports are needed e.g. when the CSV reports had already been generated, the this can be done with:
81+
82+
```shell
83+
./../../scripts/analysis/analyze.sh --report Jupyter
84+
```
85+
86+
#### Start an analysis without PDF generation
87+
88+
Generating a PDF from a Jupyter notebook using [nbconvert](https://nbconvert.readthedocs.io) might take a while or even fail due to a timeout error. Here is an example on how to skip PDF generation:
89+
90+
```shell
91+
SKIP_JUPYTER_NOTEBOOK_PDF_GENERATION=true ./../../scripts/analysis/analyze.sh
92+
```
93+
94+
#### Setup everything to explore the graph manually
95+
96+
To prepare everything for analysis including installation, configuration and preparation queries to explore the graph manually
97+
without report generation use this command:
98+
99+
```shell
100+
./../../scripts/analysis/analyze.sh --explore
101+
```
102+
67103
## Generate Markdown References
68104
69105
### Update Cypher Reference

0 commit comments

Comments
 (0)