nf-core/tumourevo
Analysis pipeline to model tumour clonal evolution from WGS data (driver annotation, quality control of copy number calls, subclonal and mutational signature deconvolution)
Define where the pipeline should find input data and save output data.
Path to comma-separated file containing information about the samples in the experiment.
string^\S+\.csv$The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.
stringMost common options used for the pipeline.
Path to reference fasta file.
stringReference genome name.
stringList of tools for running the pipeline.
stringmobster,viber,pyclone-vi,sparsesignatures,sigprofilerFlag for filtering or not QC mutations.
booleanMethod used to save pipeline results to output directory.
stringcopyVariant Annotation parameters.
Parameter for downloading VEP cache.
booleantruePath to VEP cache.
stringVEP cache version.
stringVEP species.
stringVEP reference genome name.
stringAdd an extra custom argument to VEP.
string--everything --filter_common --per_gene --total_length --offline --format vcfDriver Annotation parameters.
Path to driver table.
stringhttps://raw.githubusercontent.com/nf-core/test-datasets/refs/heads/tumourevo/data/DRIVER_ANNOTATION/ANNOTATE_DRIVER/Compendium_Cancer_Genes.tsvFiltering parameters from vcf file.
Flag for filtering mutations from vcf.
booleantrueCNAqc tool parameters.
For clonal simple CNAs, the list of segments to test.
stringc("1:0", "1:1", "2:0", "2:1", "2:2")^c\(\s*"(1:[01]|2:[012])"(?:\s*,\s*"(1:[01]|2:[012])")*\s*\)$For clonal simple CNAs, a filter for the segments to test.
numberFor subclonal segments, should the tool try to merge segments with similar CCF and the same copy number alteration?
stringUsed in the CCF estimation step.
number0.1For clonal simple CNAs, this is the same as cnaqc_min_karyotype_size, but with a cut measured on absolute mutation counts.
integer100For clonal simple CNAs, peaks detected will be filtered if, in a peak, we map less than cnaqc_p_binsize_peaks * N mutations.
number0.005For clonal simple CNAs, the purity error tolerance to determine QC pass or fail.
number0.05For clonal simple CNAs, a tolerance in comparing bands overlaps which is applied to the raw VAF values.
number0.015For clonal simple CNAs, the number of times peak detection is bootstrapped.
integer1For KDE-based matches the adjust density parameter; see density.
integer1For clonal simple CNAs, if “closest” the closest peak will be used to match the expected peak. If “rightmost” peaks are matched prioritizing right to left peaks (the higher-VAF gets matched first); this strategy is more correct in principle but works only if there are no spurious peaks in the estimated density.
stringFor subclonal simple CNAs, the starting state to determine linear versus branching evolutionary models.
string1:1Minimum number of mutations that are required to be mapped to a karyotype in order to compute CCF values.
integer25Either “ENTROPY” (default) or “ROUGH”, to reflect the two different algorithms to compute CCF.
stringjoinCNAqc
If TRUE the original CNAqc object is kept in the joinCNAqc object, otherwise it is lost.
stringpyClone-VI
The probability density used to model the read count data. Choices are beta-binomial and binomial.
stringNumber of random restarts of variational inference.
integer100Number of grid points used for approximating the posterior distribution.
integer100The number of clusters to use while fitting.
integer20Whether to use tail mutations for subclonal deconvolution or not .
stringThe minimum mixing proportion of a cluster to be returned as output.
number0.02A vector with the number of Beta components to use.
string1:5^[1-9][0-9]*:[1-9][0-9]*$Threshold for minimum VAF to use in the deconvolution
number0.05The minimum number of mutations assigned to a cluster to be returned as output.
integer10The number of fits to be computed.
integer10The concentration parameter of the Dirichlet mixture.
number0.000001The maximum number of clusters returned. Lower values speed up convergence.
integer10Maximum number of fit iterations.
integer5000The prior Beta hyperparameter for each Binomial component a
integer1The prior Beta hyperparameter for each Binomial component b
integer1The epsilon to measure convergence as ELBO absolute difference
number1e-10Initialization of the q-distribution to compute the approximation of the posterior distributions.
stringWhether points assigned to a cluster that is filtered out are re-assigned by the density function.urn the trace of model fit.
stringThe minimum Binomial success probability when applying a heuristic procedure to filter clusters after Variational Inference.
number0.05The minimum size of the mixture component when applying a heuristic procedure to filter clusters after Variational Inference.
number0.02Boolean value whether points assigned to a cluster that is filtered our, are re-assigned from the density function.
stringThe minimum number of dimensions where we want to detect a Binomial component when applying a heuristic procedure to filter clusters after Variational Inference.
integer1The number of iterations of every single run of NMF LASSO.
integer30Number of signatures to be discovered.
string2:10^[1-9][0-9]*:[1-9][0-9]*$Number of iterations to estimate the length(K) matrices beta (including the background signature) in case the argument beta is NULL. Ignored if beta is given.
integer10The number of sub-iterations involved in the sparsification phase, within a full NMF LASSO iteration.
integer10000The number of requested NMF worker subprocesses to spawn. If Inf, an adaptive maximum number is automatically chosen. If NA or NULL, the function is run as a single process.
stringallThe cross-validation test size, i.e., the percentage of entries set to zero during NMF and used for validation.
number0.01The number of repetitions of the cross-validation procedure.
integer50The number of randomized restarts of a single cross-validation repetition, in case of poor fits.
integer5The candidate values of the sparsity parameter for the signature matrix ‘beta’ whose goodness of fit is assessed by cross-validation.
stringc(0.01, 0.05, 0.1, 0.2)^c\(\s*[0-9]+(?:\.[0-9]+)?(?:\s*,\s*[0-9]+(?:\.[0-9]+)?)*\s*\)$The candidate values of the sparsity parameter for the exposure-matrix entries alpha whose goodness of fit is assessed by cross-validation.
integerSeed for the random number generation. To be set for reproducibility.
integer42The candidate values of the sparsity parameter for the exposure-matrix entries alpha whose goodness of fit is assessed by cross-validation.
stringc(0.00, 0.01, 0.05, 0.10)^c\(\s*[0-9]+(?:\.[0-9]+)?(?:\s*,\s*[0-9]+(?:\.[0-9]+)?)*\s*\)$Mode of publishing the SigProfiler genome.
stringSpecify True if the reference genome should be downloaded.
booleantrueSpecify the path to the reference genome (if downloaded by the user), e.g. path/to/genome/tsb
string‘matrix’ is used for table format inputs using a tab separated file.
stringmatrixThe minimum number of signatures to be extracted.
integer1The maximum number of signatures to be extracted.
integer25Mutation context name(s), separated by commas (,), that define the mutational contexts for signature extraction. In the default value, 96 represents the SBS96 context, DINUC represents the dinucleotide context, and ID represents the indel context.
string96,DINUC,IDThe number of iterations to be performed to extract each number signature.
integer100The minimum number of iterations to be completed before NMF converges.
integer10000The maximum number of iterations to be completed before NMF converges .
integer1000000The number number of iterations to done between checking next convergence .
integer10000The seed ensuring reproducible NMF replicate resamples.
stringrandomA number that represent the normal contamination level for which the sample is considered passed or failed.
integer3Email address for completion summary.
booleanEmail address for completion summary, only when pipeline fails.
booleanDo not use coloured log outputs.
booleanSend plain-text email instead of HTML.
booleanGit commit id for Institutional configs.
stringmasterBase directory for Institutional configs.
stringhttps://raw.githubusercontent.com/nf-core/configs/masterInstitutional config description.
booleanInstitutional config contact information.
booleanstrings3://ngi-igenomes/igenomes/Institutional config URL link.
booleanbooleanstringnull/pipeline_infobooleanbooleanstringstringhttps://raw.githubusercontent.com/nf-core/test-datasets/Suffix to add to the trace report filename. Default is the date and time in the format yyyy-MM-dd_HH-mm-ss.
stringbooleantruestringDisplay the help message.
boolean,stringDisplay the full detailed help message.
booleanDisplay hidden parameters in the help message (only works when —help or —help_full are provided).
boolean