Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasbtf committed Dec 19, 2021
1 parent 0ca3955 commit 0ea3fa6
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/user-guide/configuration.md
Original file line number Diff line number Diff line change
@@ -1 +1,16 @@
# Configuration

## Execution Mode

Accepted values: `patient`, `environment`. Defaults to `patient`.

Defines the execution mode of UnCoVar.

When the mode is set to `patient`, the sample is assumed to be from a single
host organism and contains only one strain of SARS-CoV-2. The parts of the
workflow responsible for reconstructing this SARS-CoV-2 strain genome are activated.

If the mode is set to `environment`, the sample is assumed to be from the
environment (e.g. wastewater) and to contain different SARS-CoV-2 strains.
The parts of the workflow responsible for creating and analysing individual
genomes (e.g. assembly, lineage calling via Pangolin) are disabled.

0 comments on commit 0ea3fa6

Please sign in to comment.