Skip to content

Commit

Permalink
update help
Browse files Browse the repository at this point in the history
  • Loading branch information
priesgo committed Aug 12, 2022
1 parent c26e822 commit a259f41
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 1 deletion.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,22 @@ Input:
sample2 /path/to/your/file2.vcf
Optional input:
* --input_bams: a tab-separated values file containing in each row the sample name and path to a BAM file for VAFator annotations
The input file does not have header!
Example input file:
sample1 primary:/path/to/your/file.vcf
sample1 metastasis:/path/to/your/file2.vcf
* --input_purities: a tab-separated values file containing in each row the sample name and a purity value for VAFator annotations
The input file does not have header!
Example input file:
sample1 primary:0.5
sample1 metastasis:0.6
* --input_clonalities: a tab-separated values file containing in each row the sample name and a either a
genome-wide clonality value or a Bedgraph file with local clonality values for VAFator annotations
The input file does not have header!
Example input file:
sample1 primary:3
sample1 metastasis:/path/to/metastasis.local_clonalities.bed
* --reference: path to the FASTA genome reference (indexes expected *.fai, *.dict) [required for normalization]
* --vcf-without-ad: indicate when the VCFs to normalize do not have the FORMAT/AD annotation
* --output: the folder where to publish output
Expand Down
2 changes: 1 addition & 1 deletion main.nf
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ include { VARIANT_ANNOTATION } from './modules/05_variant_annotation'

params.help= false
params.input_vcfs = false
params.input_vcf = false

// optional VAFator inputs
params.input_bams = false
params.input_vcf = false
params.input_purities = false
params.input_clonalities = false

Expand Down
16 changes: 16 additions & 0 deletions nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,22 @@ Input:
sample2 /path/to/your/file2.vcf
Optional input:
* --input_bams: a tab-separated values file containing in each row the sample name and path to a BAM file for VAFator annotations
The input file does not have header!
Example input file:
sample1 primary:/path/to/your/file.vcf
sample1 metastasis:/path/to/your/file2.vcf
* --input_purities: a tab-separated values file containing in each row the sample name and a purity value for VAFator annotations
The input file does not have header!
Example input file:
sample1 primary:0.5
sample1 metastasis:0.6
* --input_clonalities: a tab-separated values file containing in each row the sample name and a either a
genome-wide clonality value or a Bedgraph file with local clonality values for VAFator annotations
The input file does not have header!
Example input file:
sample1 primary:3
sample1 metastasis:/path/to/metastasis.local_clonalities.bed
* --reference: path to the FASTA genome reference (indexes expected *.fai, *.dict) [required for normalization]
* --output: the folder where to publish output
* --skip_normalization: flag indicating to skip all normalization steps
Expand Down

0 comments on commit a259f41

Please sign in to comment.