@@ -22,7 +22,7 @@ The directory should look like this (RunName is specified in the ConfigFile}::
2222 ├── input_data
2323 ├── logs
2424 ├── output
25- ├── processData
25+ ├── process_data
2626 └── reports
2727
2828Components within the run directory:
@@ -31,7 +31,7 @@ Components within the run directory:
3131* input_data - Directory where input fastq.gz files can be deposited
3232* logs - Directory containing log files from processing steps
3333* output - Directory containing output data from the analysis
34- * processData - Directory containing intermediate processing files
34+ * process_data - Directory containing intermediate processing files
3535* reports - Directory containing output reports and figures
3636
3737As a current convention, all processing is done within the analysis directory.
@@ -116,30 +116,44 @@ entirety of processing can start.::
116116
117117 # After constructing the config file and having reference files (i.e. sampleinfo)
118118 # You can check the samples associated with the run.
119+
119120 iguide list_samples configs/simulation.config.yml
120121
121122 # Create test analysis directory
122123 # (The simulation configuration file is used by default and does not need to be specified)
123- iguide setup configs/simulation.config.yml -- -np
124+
124125 iguide setup configs/simulation.config.yml
125126
126127 # Process a simulation dataset
128+
127129 iguide run configs/simulation.config.yml -- -np
128130 iguide run configs/simulation.config.yml -- --latency-wait 30
129- cat analysis/simulation/output/unique_sites.simulation.csv
131+ zcat analysis/simulation/output/unique_sites.simulation.csv.gz
132+
133+ # Processing will complete with a report, but if additional analyses are required,
134+ # you can reevaluate the 'incorp_sites' object. Multiple objects can be evaluated
135+ # together, just include the run files.
130136
131- # After run completion, generate a report in a different format than standard
132- iguide report analysis/simulation/output/edited_sites.simulation.rds \
133- -c configs/simulation.config.yml \
137+ iguide eval analysis/simulation/output/incorp_sites.simulation.rds \
138+ -o analysis/simulation/output/iguide.eval.simulation.test.rds \
139+ -s sampleInfo/simulation.supp.csv
140+
141+ # After evaluation, generate a report in a different format than standard.
142+ # Additionally the evaluation and report generation step can be combined using
143+ # config file(s) as inputs for the 'report' subcommand.
144+
145+ iguide report -e analysis/simulation/output/iguide.eval.simulation.test.rds \
134146 -o analysis/simulation/reports/report.simulation.pdf \
135147 -s sampleInfo/simulation.supp.csv \
136148 -t pdf
137149
138150 # When you are all finished and ready to archive / remove excess files, a minimal configuration
139151 # can be achived with the 'clean' subcommand.
152+
140153 iguide clean configs/simulation.config.yml
141154
142155 # Or you realized you messed up all the input and need to restart
156+
143157 iguide clean configs/simulation.config.yml --remove_proj
144158
145159
0 commit comments