nf-core/scdownstream
A single cell transcriptomics pipeline for QC, integration and making the data presentable
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$You will need to create a design file with information about the samples in your experiment before running the pipeline. Use this parameter to specify its location. It has to be a comma-separated file with 3 columns, and a header row. See usage docs.
The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.
stringSave intermediate files to the output directory
booleanEmail address for completion summary.
string^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$Set this parameter to your e-mail address to get a summary e-mail with details of the run sent to you when the workflow exits. If set in your user config file (~/.nextflow/config) then you don't need to specify this on the command line for every run.
MultiQC report title. Printed as page header, used for filename if not otherwise specified.
stringOptions for mapping new data to a reference. Check the [section in the usage docs](https://nf-co.re/scdownstream/docs/usage/#reference-mapping) for more information.
If you want to project new data onto an already integrated object, specify the path to the base AnnData object here
string^\S+\.h5ad$The file should be in the .h5ad format.
The column in the base AnnData object that contains the label (e.g. cell type) information.
stringlabelThe keys in the obsm of the base AnnData object that contain the embeddings (without leading X_). Required if input is not provided - otherwise it is ignored.
string^((scvi|scanvi|harmony|bbknn|combat|seurat)(,(scvi|scanvi|harmony|bbknn|combat|seurat))*)?$If the input parameter is not provided (no new data to add), integration will not be performed. In order to be able to utilize existing integration results, you need to provide the keys in the obsm of the base AnnData object that contain the embeddings (without leading X_).
If you want to use a pre-trained scVI/scANVI model as a reference for integration, specify the path to the model .pt file here
string^\S+\.pt$The file should be in the .pt format. If provided, you also need to provide a reference_model_type.
Specify the type of model provided in the reference_model parameter
stringscviCan be either 'scvi' or 'scanvi'.
This parameter must be a combination of the following values:scvi, scanviOptions for selecting which tools should be used for certain tasks
Only run the preprocessing steps, skip the integration and clustering steps
booleanUnify gene symbols to the latest version of the Ensembl database
booleanScale the memory requirements for each process by this factor. Should be increased if you have a large number of cells.
integer1Specify the tool to use for ambient RNA removal
stringSpecify the tools to use for doublet detection. Setting to 'none' will skip this step
stringscrublet^(none|((solo|scrublet|doubletdetection|scds)?,?)*[^,]+$)If you want to use multiple tools, separate them with a comma. Available methods are: solo, scrublet, doubletdetection, scds
Number of tools that need to agree on a doublet for it to be called as such
integer1Force keeping certain columns in the merged AnnData object, even if they are not present in all samples
string^([a-zA-Z0-9_]*(,[a-zA-Z0-9_]*)*)?$If you want to keep certain columns in the merged AnnData object, even if they are not present in all samples, specify them here. Separate them with a comma.
Specify the tool to use for integration
stringscvi^((scvi|scanvi|harmony|bbknn|combat|seurat)(,(scvi|scanvi|harmony|bbknn|combat|seurat))*)?$If you want to use multiple tools, separate them with a comma. Available methods are: scvi, scanvi, harmony, bbknn, combat, seurat
Number of highly variable genes to use for integration
integer10000Specify the resolutions for clustering
string0.5,1.0^\d+(\.\d+)?(,\d+(\.\d+)?)*$Specify the resolutions for clustering. If you want to use multiple resolutions, separate them with a comma.
Create a UMAP and a clustering for each unique value in the label column (and for each integration method)
booleanCreate a global UMAP and clustering (for each integration method)
booleantrueSkip the LIANA step. For large datasets, the pipeline might fail due to high memory usage in this step. Use this option to skip it.
booleanSkip the rank_genes_groups step. For large datasets, the pipeline might fail due to high memory usage in this step. Use this option to skip it.
booleanSpecify the models to use for the celltypist cell type annotation
string^([a-zA-Z0-9_]*(,[a-zA-Z0-9_]*)*)?$If you want to use multiple models, separate them with a comma. Available models can be found here.
Number of epochs to train the CellBender model
integer150Method to aggregate gene expression values for non-unique genes
stringMethod to aggregate gene expression values for non-unique genes. Available methods are: mean, sum, max
Use GPU acceleration for tasks that support it
booleanPrepare the output for visualisation in cellxgene
booleanOptions for the scVI and scANVI integration methods
Number of latent dimensions for scVI/scANVI
integer30Number of hidden units in the neural network for scVI/scANVI
integer128Number of layers in the neural network for scVI/scANVI
integer2Dispersion parameter for scVI/scANVI
stringDispersion parameter for scVI/scANVI. Can be 'gene', 'gene-batch', 'gene-label', or 'gene-cell'.
Gene likelihood for scVI/scANVI
stringGene likelihood for scVI/scANVI. Can be 'zinb', 'nb', 'poisson', or 'normal'.
Maximum number of epochs for training scVI/scANVI. If not set, a heuristic provided by scVI/scANVI will be used.
integerParameters used to describe centralised config profiles. These should not be edited.
Git commit id for Institutional configs.
stringmasterBase directory for Institutional configs.
stringhttps://raw.githubusercontent.com/nf-core/configs/masterIf you're running offline, Nextflow will not be able to fetch the institutional config files from the internet. If you don't need them, then this is not a problem. If you do need them, you should download the files from the repo and tell Nextflow where to find them with this parameter.
Institutional config name.
stringInstitutional config description.
stringInstitutional config contact information.
stringInstitutional config URL link.
stringLess common options for the pipeline, typically set in a config file.
Display version and exit.
booleanMethod used to save pipeline results to output directory.
stringThe Nextflow publishDir option specifies which intermediate files should be saved to the output directory. This option tells the pipeline what method should be used to move these files. See Nextflow docs for details.
Email address for completion summary, only when pipeline fails.
string^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$An email address to send a summary email to when the pipeline is completed - ONLY sent if the pipeline does not exit successfully.
Send plain-text email instead of HTML.
booleanFile size limit when attaching MultiQC reports to summary emails.
string25.MB^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$Do not use coloured log outputs.
booleanIncoming hook URL for messaging service
stringIncoming hook URL for messaging service. Currently, MS Teams and Slack are supported.
Custom config file to supply to MultiQC.
stringCustom logo file to supply to MultiQC. File name must also be set in the MultiQC config file
stringCustom MultiQC yaml file containing HTML including a methods description.
stringBoolean whether to validate parameters against the schema at runtime
booleantrueBase URL or local path to location of pipeline test dataset files
stringhttps://raw.githubusercontent.com/nf-core/test-datasets/