You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,6 @@ The pipeline is built using [Nextflow](https://www.nextflow.io), a workflow tool
38
38
```
39
39
40
40
Note that some form of configuration will be needed so that Nextflow knows how to fetch the required software. This is usually done in the form of a config profile (`YOURPROFILE` in the example command above). You can chain multiple config profiles in a comma-separated string.
41
-
42
41
- The pipeline comes with config profiles called `docker`, `singularity`, `podman`, `shifter`, `charliecloud` and `conda` which instruct the pipeline to use the named tool for software management. For example, `-profile test,docker`.
43
42
- Please check [nf-core/configs](https://github.com/nf-core/configs#documentation) to see if a custom config file to run nf-core pipelines already exists for your Institute. If so, you can simply use `-profile <institute>` in your command. This will enable either `docker` or `singularity` and set the appropriate execution settings for your local compute environment.
44
43
- If you are using `singularity`, please use the [`nf-core download`](https://nf-co.re/tools/#downloading-pipelines-for-offline-use) command to download images first, before running the pipeline. Setting the [`NXF_SINGULARITY_CACHEDIR` or `singularity.cacheDir`](https://www.nextflow.io/docs/latest/singularity.html?#singularity-docker-hub) Nextflow options enables you to store and re-use the images from a central location for future pipeline runs.
@@ -65,6 +64,7 @@ The samplesheet should be a tab-separated file with the following columns:
65
64
-`NCBI_accession`: SRA accession number(s), separated by semicolons for multiple runs
66
65
67
66
For local FASTQ files (with `--local_input`):
67
+
68
68
-`sample_id`: Unique sample identifier
69
69
-`file_paths`: Path(s) to FASTQ file(s), separated by semicolons for multiple files
70
70
@@ -127,17 +127,21 @@ Multiple profiles can be specified by separating them with a comma.
127
127
### Main arguments
128
128
129
129
#### `--input`
130
+
130
131
Path to input samplesheet (TSV format). This replaces the older `--metadata_tsv` parameter.
131
132
132
133
#### `--outdir`
134
+
133
135
The output directory where the results will be saved. You must use absolute paths to storage on Cloud infrastructure.
134
136
135
137
#### `--local_input`
138
+
136
139
Set to `true` to provide local FASTQ file paths instead of downloading from SRA.
137
140
138
141
Default: `false`
139
142
140
143
#### `--skip_humann`
144
+
141
145
Skip HUMAnN functional profiling step.
142
146
143
147
Default: `false`
@@ -152,26 +156,31 @@ The pipeline will automatically download and cache reference databases in the lo
152
156
- Human and mouse reference genomes for KneadData
153
157
154
158
#### `--store_dir`
159
+
155
160
Directory to store reference databases.
156
161
157
162
Default: `'databases'`
158
163
159
164
#### `--metaphlan_index`
165
+
160
166
MetaPhlAn database index version.
161
167
162
168
Default: `'latest'`
163
169
164
170
#### `--chocophlan`
171
+
165
172
ChocoPhlAn database version for HUMAnN.
166
173
167
174
Default: `'full'`
168
175
169
176
#### `--uniref`
177
+
170
178
UniRef database version for HUMAnN.
171
179
172
180
Default: `'uniref90_diamond'`
173
181
174
182
#### `--organism_database`
183
+
175
184
Organism reference database for KneadData contamination removal.
176
185
177
186
Options: `'human_genome'`, `'mouse_C57BL'`
@@ -207,15 +216,19 @@ If you use seandavi/curatedmetagenomicsnextflow for your analysis, please cite t
> Blanco-Míguez A, Beghini F, Cumbo F, et al. Extending and improving metagenomic taxonomic profiling with uncharacterized species using MetaPhlAn 4. Nat Biotechnol. 2023;41(11):1633-1644. doi:10.1038/s41587-023-01688-w
211
221
212
222
-[HUMAnN](https://github.com/biobakery/humann)
223
+
213
224
> Beghini F, McIver LJ, Blanco-Míguez A, et al. Integrating taxonomic, functional, and strain-level profiling of diverse microbial communities with bioBakery 3. eLife. 2021;10:e65088. doi:10.7554/eLife.65088
0 commit comments