Skip to content

Commit 0895eb8

Browse files
authored
[Documentation] Update qc_check documentation (#1014)
1 parent 52de103 commit 0895eb8

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/common_text/qc_check_task.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<!-- if: theiacov -->
99
The `qc_check` task applies quality thresholds according to the specified organism, which should match the _standardized_ `organism` input in the TheiaCoV workflows.
1010

11-
Segment-based QC can be applied to influenza genomes for "percent_reference_coverage", "median_coverage", and "num_minor_snv". To apply thresholds across all individual segments, use "segment_" as a prefix for the QC threshold column in the QC check template. To apply thresholds to individual segments, use the following prefixes: "mp_", "pb1_", "pb2_", "na_", "ns_", "np_", "pa_", and "ha_". Segment-specific thresholds are preferentially used over general segment thresholds if both are present.
11+
Segment-based QC can be applied to influenza genomes for "percent_reference_coverage", "median_coverage", and "num_minor_snv". To apply thresholds across all segments, use "segment_" as a prefix for the QC threshold column in the QC check template. To apply thresholds to individual segments, use the following prefixes: "mp_", "pb1_", "pb2_", "na_", "ns_", "np_", "pa_", and "ha_". For example, percent reference coverage for the mp segment should have a column labeled `mp_percent_reference_coverage`. Segment-specific thresholds are preferentially used over general segment thresholds if both are present. If all segment-specific thresholds are provided for a metric, the general segment threshold for that metric should be left blank. Otherwise, the `qc_check` output will contain a `QC_ALERT` message. If some segment-specific thresholds are provided for a metric, the general segment threshold will only be used for segments that do not have a provided threshold.
1212
<!-- endif -->
1313
<!-- if: theiaprok|theiaeuk -->
1414
The `qc_check` task applies quality thresholds according to the sample taxa. The sample taxa is taken from the `gambit_predicted_taxon` value inferred by the GAMBIT module OR can be manually provided by the user using the `expected_taxon` workflow input.

0 commit comments

Comments
 (0)