Skip to content

Commit

Permalink
extend docs for optional parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
AmandaBirmingham committed Oct 2, 2024
1 parent bcd8d46 commit 8eac1b6
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,16 @@ qiime tools import \
--type SurpiCountTable
qiime tools import \
--input-path surpi_sample_sheet.txt \
--input-path surpi_sample_info.csv \
--output-path surpi_sample_info.qza \
--type SurpiSampleSheet
```

With these artifacts, it is simple to extract a `FeatureTable[Frequency]`
QIIME object containing the counts generated by SURPI, as well as a
`FeatureData[Taxonomy]` QIIME object containing the associated taxonomies:
`FeatureData[Taxonomy]` QIIME object containing the associated taxonomies.
Assuming that the SURPI sample sheet is linked to the counttable files by
barcode IDs, this can be accomplished by running:

```
qiime surpi extract \
Expand All @@ -54,5 +56,18 @@ qiime surpi extract \
--o-taxonomy surpi_taxonomy.qza
```

Alternatively, if the sample sheet and counttable files are linked by the Sample_ID
values, the command can be altered to set the optional `--p-ids-are-barcodes`
parameter to `False`

```
qiime surpi extract \
--i-surpi-output surpi_output_by_sample_id.qza \
--i-surpi-sample-info surpi_sample_info.qza \
--p-ids-are-barcodes False \
--o-table surpi_counts.qza \
--o-taxonomy surpi_taxonomy.qza
```

These objects are suitable for use in downstream QIIME functions such as
`qiime diversity core-metrics-phylogenetic` or `qiime taxa barplot`.
2 changes: 1 addition & 1 deletion q2_surpi/tests/data/surpi_sample_info.csv
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ IEMFileVersion,4,,,,,,,,
,,,,,,,,,
Investigator Name,VS,,,,,,,,
,,,,,,,,,
Experiment Name,WW_NS_230126_qiime,,,,,,,,
Experiment Name,qiime_test,,,,,,,,
,,,,,,,,,
Date,1/26/23,,,,,,,,
,,,,,,,,,
Expand Down

0 comments on commit 8eac1b6

Please sign in to comment.