Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SilasK committed Oct 11, 2023
1 parent 80bc71f commit 2871b8a
Showing 1 changed file with 6 additions and 14 deletions.
20 changes: 6 additions & 14 deletions docs/usage/output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,6 @@ Quality control
::

atlas run qc
# or
atlas run genomes
# or
atlas run genecatalog

Runs quality control of single or paired end reads and summarizes the main QC stats in
`reports/QC_report.html`_.
Expand All @@ -31,8 +27,8 @@ Runs quality control of single or paired end reads and summarizes the main QC st

Per sample it generates:

- ``{sample}/sequence_quality_control/{sample}_QC_{fraction}.fastq.gz``
- Various quality stats in ``sample}/sequence_quality_control/read_stats``
- ``QC/reads/{sample}_{fraction}.fastq.gz``


.. _fractions:

Expand All @@ -50,17 +46,14 @@ Assembly
::

atlas run assembly
#or
atlas run genomes
# or
atlas run genecatalog



Besides the `reports/assembly_report.html`_ this rule outputs the following files per sample:

- ``Assembly/fasta/{sample}.fasta``
- ``{sample}/sequence_alignment/{sample}.bam``
- ``{sample}/assembly/contig_stats/final_contig_stats.txt``



.. _reports/assembly_report.html: ../_static/assembly_report.html
Expand All @@ -75,11 +68,10 @@ Binning
::

atlas run binning
#or
atlas run genomes


When you use different binners (e.g. metabat, maxbin) and a bin-reconciliator (e.g. DAS Tool),

When you use different binners (e.g. vamb, metabat, DASTool),
then Atlas will produce for each binner and sample:

- ``{sample}/binning/{binner}/cluster_attribution.tsv``
Expand Down

0 comments on commit 2871b8a

Please sign in to comment.