nf-core/pixelator
Pipeline to generate Proximity Network Assay data with Pixelator (Pixelgen Technologies AB)
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|tsv|yml|yaml)$Path to a local or remote directory that is the “current working directory” for relative paths defined in the input samplesheet
stringThe output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.
stringEmail address for completion summary.
string^([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.
integerDrop reads whose average quality in marker and UMI regions is below this.
integer20Drop low-complexity UMIs where one base makes up more than this fraction of the UMI.
number0.8Drop reads whose UMI aligns to any substring of an assay LBS (or its reverse complement) within this many edits (Levenshtein distance).
integer6Save the intermediate per-read edgelist parquet file generated from the raw input reads.
booleanSave the reads that were dropped by the edgelist step, with the reason they were dropped.
booleanOptions for collapsing per-read edgelists into unique molecules.
Save the aggregated molecule-level parquet file.
booleanSave the PXL dataset after the graph stage.
booleanActivate the multiplet recovery using leiden community detection
booleantrueThe resolution parameter for the leiden algorithm at the initial stage.
number1The resolution parameter for the leiden algorithm at the refinement stage.
number0.5Activate edge cycle verification to remove edges from well connected regions that are not part of cycles in the graph.
booleantrueDiscard edges with a read count below given value. Set to 1 to disable filtering.
number1The maximum recursion depth for the refinement algorithm. Set to 1 to disable refinement.
integer3The maximum number of edges to remove between components during the initial stage (iteration == 0) of multiplet recovery.
integer10The maximum number of edges to remove between components during the refinement stage (iteration > 0) of multiplet recovery.
integer20The 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.
numberThe 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.
numberComponents with fewer nodes than this will be filtered from the output data. Set to null to enable automatic size filtering based on the data.
integer8000Components with more nodes than this will be filtered from the output data. Set to null to enable automatic size filtering based on the data.
integer1000000Options for collapsing likely UMI sequencing errors on low-degree nodes after the graph step.
Skip graph-collapse step
booleanSave the PXL dataset after the graph-collapse stage.
booleanMaximum number of hops from a searched node to look for a same-marker, same-role collapse candidate.
integer6Maximum Hamming distance (inclusive) between a searched node’s UMI and a candidate’s UMI for the node to be collapsed into that candidate.
integer2Search a node for a collapse target only when its degree is at most this value. 1 investigates only leaves.
integer1Also write a TSV file listing the component, original UMI and corrected UMI of every collapsed node.
booleanSave the PXL dataset after the sample calling stage.
booleanSave components that could not be confidently assigned to any sample to a separate pxl file.
booleanRemove antibodies that are incompatible with their component’s called sample.
booleantrueEnrichment threshold for sample calling.
number10Skip denoise step
booleanSave the PXL dataset after the denoise stage.
booleanActivate the one-core graph denoising algorithm
booleanThe p-value threshold for the a marker to be considered significantly over-expressed in the one-core layer of a component
number0.05The inflate factor for the number of nodes from over-expressed markers to be removed from the one-core layer of a component
number1.5Remove nodes in the peripheral-like partition using adaptive core expansion (ACE).
booleantrueNeighborhood radius in graph steps for ACE denoising.
integer3Run PLS-on-coreness denoising and retain the largest connected component after filtering.
booleantrueAll retained PLS score columns must exceed this value.
number-3Skip analysis step
booleanCompute proximity scores
booleantrueCompute k-core summary tables for each component
booleantrueCompute the variance explained by the SVD components
booleantrueNumber of pivots to use for the SVD decomposition
integer50Skip experiment summary generation
booleanGlobal configuration options specific to nf-core/pixelator.
Override the container image reference to use for all steps using the pixelator command.
stringOverride the container image to use for the experiment summary step.
stringSave all intermediate results.
booleanSave all JSON report and metadata files generated by pixelator.
booleantrueThe technology used to process the samples
stringParameters 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/masterInstitutional 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.
stringEmail address for completion summary, only when pipeline fails.
string^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$Send plain-text email instead of HTML.
booleanDo not use coloured log outputs.
booleanBoolean 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/01e25e321a58712db5d7ecc3c78c80396b22ac04/Base path / URL for data used in the modules
stringhttps://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.
stringDisplay 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