Skip to content

Commit

Permalink
Merge pull request #69 from nf-core/update-usage
Browse files Browse the repository at this point in the history
Update documentation in usage.md
  • Loading branch information
scwatts authored Jul 18, 2024
2 parents b438878 + b4523d1 commit 1b087b6
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,17 @@ samplesheet. The supported analysis types for each workflow are listed below.

<sub><sup>\*</sup> Supported analyses relate to the TSO500 panel only</sub>

:::note

The default settings of `oncoanalyser` will accommodate typical sequencing depths for sample inputs and each individual
tool is generally sequencing depth agnostic. However, variant calling is optimised for 100x tumor and 40x normal when
invoked in `wgts` mode and expects sparse high-depth read data characteristic of panel sequencing when run in `targeted`
mode. For atypical input sequence data you may consult the [hmftools
documentation](https://github.com/hartwigmedical/hmftools) and [configure](#custom-tool-arguments) `oncoanalyser`
accordingly.

:::

## Samplesheet

A samplesheet that contains information of each input in CSV format is needed to run `oncoanalyser`. The required input
Expand Down Expand Up @@ -320,7 +331,7 @@ params {
To use these hmftools resource file overrides in `oncoanalyser` the local bundle directory must be provided with
`--ref_data_hmf_data_path`.

#### Customise other data
#### Customising other data

The path or URI to the VIRUSBreakend database can also be explicitly set with `--ref_data_virusbreakenddb_path`. There
are additional arguments to manually set various other reference data files, please review the parameters documentation
Expand Down

0 comments on commit 1b087b6

Please sign in to comment.