From 2871b8a1d6093b4caf1cad03145bcd3daa001f71 Mon Sep 17 00:00:00 2001 From: silask Date: Wed, 11 Oct 2023 10:18:30 +0200 Subject: [PATCH] update docs --- docs/usage/output.rst | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/docs/usage/output.rst b/docs/usage/output.rst index f01cc3f5..e0f2237a 100644 --- a/docs/usage/output.rst +++ b/docs/usage/output.rst @@ -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`_. @@ -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: @@ -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 @@ -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``