Skip to content

Commit 3fc4b79

Browse files
Merge pull request #81 from torres-alexis/DEV2_SW_AmpIllumina-B
Improved --target documentation to clarify that it is required Fixed example run command to include --target
2 parents 38829da + 6193ae6 commit 3fc4b79

File tree

1 file changed

+2
-2
lines changed
  • Amplicon/Illumina/Workflow_Documentation/SW_AmpIllumina-B

1 file changed

+2
-2
lines changed

Amplicon/Illumina/Workflow_Documentation/SW_AmpIllumina-B/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ ___
9595
> This approach processes data hosted on the [NASA Open Science Data Repository (OSDR)](https://osdr.nasa.gov/bio/repo/). Upon execution, the command downloads then parses the OSD ISA.zip file to create a runsheet containing link(s) to the raw reads and the metadata required for processing. The runsheet is then used to prepare the necessary configuration files before executing the workflow using the specified Snakemake run command.
9696
9797
```bash
98-
python ./scripts/run_workflow.py --OSD OSD-487 --run "snakemake --use-conda --conda-prefix ${CONDA_PREFIX}/envs -j 2 -p"
98+
python ./scripts/run_workflow.py --OSD OSD-487 --target 16S --run "snakemake --use-conda --conda-prefix ${CONDA_PREFIX}/envs -j 2 -p"
9999
```
100100
101101
<br>
@@ -123,7 +123,7 @@ ___
123123
* `--OSD OSD-###` - specifies the OSD dataset to process through the SW_AmpIllumina workflow (replace ### with the OSD number)
124124
> *Used for Approach 1 only.*
125125
126-
* `--target` - specifies the genomic target for the assay. Options: 16S, 18S, ITS. This determines which reference database is used for taxonomic classification, and it is used to select the appropriate dataset from an OSD study when multiple options are available.
126+
* `--target` - this is a required parameter that specifies the genomic target for the assay. Options: 16S, 18S, ITS. This determines which reference database is used for taxonomic classification, and it is used to select the appropriate dataset from an OSD study when multiple options are available.
127127
> *Note: Swift Amplicon 16S+ITS datasets, which use multiple primer sets, are not suitable for processing with this workflow. OSD datasets of this type are processed using alternative methods.*
128128
129129
* `--runsheetPath` - specifies the path to a local runsheet containing the metadata and raw reads location (as a link or local path), used for processing a non-OSD dataset through the SW_AmpIllumina workflow

0 commit comments

Comments
 (0)