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.

required
type: string
pattern: ^\S+\.(csv|tsv|yml|yaml)$

Path to a local or remote directory that is the “current working directory” for relative paths defined in the input samplesheet

type: string

The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.

required
type: string

Email address for completion summary.

type: string
pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

Options for building a per-read edgelist directly from FASTQ.

Allow this many mismatches when matching marker barcodes.

type: integer

Drop reads whose average quality in marker and UMI regions is below this.

type: integer
default: 20

Drop low-complexity UMIs where one base makes up more than this fraction of the UMI.

type: number
default: 0.8

Drop reads whose UMI aligns to any substring of an assay LBS (or its reverse complement) within this many edits (Levenshtein distance).

type: integer
default: 6

Save the intermediate per-read edgelist parquet file generated from the raw input reads.

type: boolean

Save the reads that were dropped by the edgelist step, with the reason they were dropped.

type: boolean

Options for collapsing per-read edgelists into unique molecules.

Save the aggregated molecule-level parquet file.

type: boolean

Save the PXL dataset after the graph stage.

type: boolean

Activate the multiplet recovery using leiden community detection

type: boolean
default: true

The resolution parameter for the leiden algorithm at the initial stage.

type: number
default: 1

The resolution parameter for the leiden algorithm at the refinement stage.

type: number
default: 0.5

Activate edge cycle verification to remove edges from well connected regions that are not part of cycles in the graph.

type: boolean
default: true

Discard edges with a read count below given value. Set to 1 to disable filtering.

type: number
default: 1

The maximum recursion depth for the refinement algorithm. Set to 1 to disable refinement.

type: integer
default: 3

The maximum number of edges to remove between components during the initial stage (iteration == 0) of multiplet recovery.

type: integer
default: 10

The maximum number of edges to remove between components during the refinement stage (iteration > 0) of multiplet recovery.

type: integer
default: 20

The maximum number of edges to remove between two components relative to the number of nodes in the smaller of the two when during the initial stage (iteration == 0) of multiplet recovery.

type: number

The maximum number of edges to remove between two components relative to the number of nodes in the smaller of the two when during the refinement stage (iteration > 0) of multiplet recovery.

type: number

Components with fewer nodes than this will be filtered from the output data. Set to null to enable automatic size filtering based on the data.

type: integer
default: 8000

Components with more nodes than this will be filtered from the output data. Set to null to enable automatic size filtering based on the data.

type: integer
default: 1000000

Options for collapsing likely UMI sequencing errors on low-degree nodes after the graph step.

Skip graph-collapse step

type: boolean

Save the PXL dataset after the graph-collapse stage.

type: boolean

Maximum number of hops from a searched node to look for a same-marker, same-role collapse candidate.

type: integer
default: 6

Maximum Hamming distance (inclusive) between a searched node’s UMI and a candidate’s UMI for the node to be collapsed into that candidate.

type: integer
default: 2

Search a node for a collapse target only when its degree is at most this value. 1 investigates only leaves.

type: integer
default: 1

Also write a TSV file listing the component, original UMI and corrected UMI of every collapsed node.

type: boolean

Save the PXL dataset after the sample calling stage.

type: boolean

Save components that could not be confidently assigned to any sample to a separate pxl file.

type: boolean

Remove antibodies that are incompatible with their component’s called sample.

type: boolean
default: true

Enrichment threshold for sample calling.

type: number
default: 10

Skip denoise step

type: boolean

Save the PXL dataset after the denoise stage.

type: boolean

Activate the one-core graph denoising algorithm

type: boolean

The p-value threshold for the a marker to be considered significantly over-expressed in the one-core layer of a component

type: number
default: 0.05

The inflate factor for the number of nodes from over-expressed markers to be removed from the one-core layer of a component

type: number
default: 1.5

Remove nodes in the peripheral-like partition using adaptive core expansion (ACE).

type: boolean
default: true

Neighborhood radius in graph steps for ACE denoising.

type: integer
default: 3

Run PLS-on-coreness denoising and retain the largest connected component after filtering.

type: boolean
default: true

All retained PLS score columns must exceed this value.

type: number
default: -3

Skip analysis step

type: boolean

Compute proximity scores

type: boolean
default: true

Compute k-core summary tables for each component

type: boolean
default: true

Compute the variance explained by the SVD components

type: boolean
default: true

Number of pivots to use for the SVD decomposition

type: integer
default: 50

Skip experiment summary generation

type: boolean

Global configuration options specific to nf-core/pixelator.

Override the container image reference to use for all steps using the pixelator command.

type: string

Override the container image to use for the experiment summary step.

type: string

Save all intermediate results.

type: boolean

Save all JSON report and metadata files generated by pixelator.

type: boolean
default: true

The technology used to process the samples

required
type: string

Parameters used to describe centralised config profiles. These should not be edited.

Git commit id for Institutional configs.

hidden
type: string
default: master

Base directory for Institutional configs.

hidden
type: string
default: https://raw.githubusercontent.com/nf-core/configs/master

Institutional config name.

hidden
type: string

Institutional config description.

hidden
type: string

Institutional config contact information.

hidden
type: string

Institutional config URL link.

hidden
type: string

Less common options for the pipeline, typically set in a config file.

Display version and exit.

hidden
type: boolean

Method used to save pipeline results to output directory.

hidden
type: string

Email address for completion summary, only when pipeline fails.

hidden
type: string
pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

Send plain-text email instead of HTML.

hidden
type: boolean

Do not use coloured log outputs.

hidden
type: boolean

Boolean whether to validate parameters against the schema at runtime

hidden
type: boolean
default: true

Base URL or local path to location of pipeline test dataset files.

hidden
type: string
default: https://raw.githubusercontent.com/nf-core/test-datasets/01e25e321a58712db5d7ecc3c78c80396b22ac04/

Base path / URL for data used in the modules

hidden
type: string
default: https://raw.githubusercontent.com/nf-core/test-datasets/modules/data/

Suffix to add to the trace report filename. Default is the date and time in the format yyyy-MM-dd_HH-mm-ss.

hidden
type: string

Display the help message.

type: boolean,string

Display the full detailed help message.

type: boolean

Display hidden parameters in the help message (only works when –help or –help_full are provided).

type: boolean