Skip to content

Commit

Permalink
docs: Update docs for file output in stead of folders
Browse files Browse the repository at this point in the history
  • Loading branch information
KHajji committed Apr 22, 2022
1 parent b0dfef8 commit 7c47393
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ trueconsense \
--reference reference.fasta \
--features reference-features.gff \
--samplename example \
--output test_output/ \
--output test_output/example_cov_ge_50.fa \
--coverage-level 50
```

Expand All @@ -45,7 +45,7 @@ Aside from just creating a consensus-sequence, TrueConsense can also provide you
--reference reference.fasta \
--features reference-features.gff \
--samplename example \
--output test_output/ \
--output test_output/example_cov_ge_30.fa \
--coverage-level 30 \
--depth-of-coverage example_coverage.tsv
```
Expand All @@ -63,9 +63,9 @@ Aside from just creating a consensus-sequence, TrueConsense can also provide you
--reference reference.fasta \
--features reference-features.gff \
--samplename example \
--output test_output/ \
--output test_output/example_cov_ge_30.fa \
--coverage-level 30 \
--variants vcf_output/
--variants vcf_output/example_cov_ge_30.vcf
```

??? summary "Generating updated GFF files"
Expand All @@ -81,9 +81,9 @@ Aside from just creating a consensus-sequence, TrueConsense can also provide you
--reference reference.fasta \
--features reference-features.gff \
--samplename example \
--output test_output/ \
--output test_output/example_cov_ge_30.fa \
--coverage-level 30 \
--output-gff gff_output/
--output-gff gff_output/example_cov_ge_30.gff
```

TrueConsense calls IUPAC nucleotide ambiguity-codes by default when an aligned-position has an even (or near-even) split of nucleotides.
Expand All @@ -110,4 +110,4 @@ This can be done with the `--index-override` flag, the data must be provided as

!!! warning "Please only use this when absolutely necessary"
Using the index override may solve a very specific issue for you particular analysis, but it will also cause the result to be much harder to validate.
Additionally, this may introduce new issues as there is little to no validation of the override-data which will be handled as "truthful" data.
Additionally, this may introduce new issues as there is little to no validation of the override-data which will be handled as "truthful" data.

0 comments on commit 7c47393

Please sign in to comment.