pixelator

Pipeline to generate Molecular Pixelation data with Pixelator (Pixelgen Technologies AB)

https://github.com/nf-core/pixelator

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 13 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.0%) to scientific vocabulary

Keywords

molecular-pixelation nextflow nf-core pipeline pixelator pixelgen-technologies proteins single-cell single-cell-omics workflow
Last synced: 6 months ago · JSON representation ·

Repository

Pipeline to generate Molecular Pixelation data with Pixelator (Pixelgen Technologies AB)

Basic Info
  • Host: GitHub
  • Owner: nf-core
  • License: mit
  • Language: Nextflow
  • Default Branch: master
  • Homepage: https://nf-co.re/pixelator
  • Size: 5.4 MB
Statistics
  • Stars: 11
  • Watchers: 167
  • Forks: 7
  • Open Issues: 2
  • Releases: 8
Topics
molecular-pixelation nextflow nf-core pipeline pixelator pixelgen-technologies proteins single-cell single-cell-omics workflow
Created over 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

nf-core/pixelator

GitHub Actions CI Status GitHub Actions Linting Status AWS CI Cite with Zenodo nf-test

Nextflow run with conda run with docker run with singularity Launch on Seqera Platform

Get help on SlackFollow on TwitterFollow on MastodonWatch on YouTube

Introduction

nf-core/pixelator is a bioinformatics best-practice analysis pipeline for analysis of data from the Molecular Pixelation (MPX) and Proximity Network (PNA) assays. It takes a samplesheet as input and will process your data using pixelator to produce a PXL file containing single-cell protein abundance and protein interactomics data.

Depending on the input data the pipeline will run different steps.

For PNA data, the pipeline will run the following steps:

  1. Do quality control checks of input reads and build amplicons (pixelator single-cell-pna amplicon)
  2. Create groups of amplicons based on their marker assignments (pixelator single-cell-pna demux)
  3. Derive original molecules to use as edge list downstream by error correcting, and counting input amplicons (pixelator single-cell-pna collapse)
  4. Compute the components of the graph from the edge list in order to create putative cells (pixelator single-cell-pna graph)
  5. Analyze the spatial information in the cell graphs (pixelator single-cell-pna analysis)
  6. Generate 3D graph layouts for visualization of cells (pixelator single-cell-pna layout)
  7. Report generation (pixelator single-cell-pna report)

For MPX data, the pipeline will run the following steps:

  1. Build an amplicons from the input reads (pixelator single-cell-mpx amplicon)
  2. Read QC and filtering, correctness of the pixel binding sequence sequences (pixelator single-cell-mpx preqc | pixelator adapterqc)
  3. Assign a marker (barcode) to each read (pixelator single-cell-mpx demux)
  4. Error correction, duplicate removal, compute read counts (pixelator single-cell-mpx collapse)
  5. Compute the components of the graph from the edge list in order to create putative cells (pixelator single-cell-mpx graph)
  6. Call and annotate cells (pixelator single-cell-mpx annotate)
  7. Analyze the cells for polarization and colocalization (pixelator single-cell-mpx analysis)
  8. Generate 3D graph layouts for visualization of cells (pixelator single-cell-mpx layout)
  9. Report generation (pixelator single-cell-mpx report)

[!WARNING] Since Nextflow 23.07.0-edge, Nextflow no longer mounts the host's home directory when using Apptainer or Singularity. This causes issues in some dependencies. As a workaround, you can revert to the old behavior by setting the environment variable NXF_APPTAINER_HOME_MOUNT or NXF_SINGULARITY_HOME_MOUNT to true in the machine from which you launch the pipeline.

Usage

[!NOTE] If you are new to Nextflow and nf-core, please refer to this page on how to set-up Nextflow. Make sure to test your setup with -profile test before running the workflow on actual data.

First, prepare a samplesheet with your input data that looks as follows (the exact values you need to input depend on the design and panel you are using):

samplesheet.csv:

csv sample,design,panel,fastq_1,fastq_2 sample1,pna-2,proxiome-immuno-155,sample1_R1_001.fastq.gz,sample1_R2_001.fastq.gz

Each row represents a sample and gives the design, a panel file and the input fastq files.

Now, you can run the pipeline using:

bash nextflow run nf-core/pixelator \ -profile <docker/singularity/.../institute> \ --input samplesheet.csv \ --outdir <OUTDIR>

[!WARNING] This version of the pipeline does not support conda environments, due to issues with upstream dependencies. This means you cannot use the conda and mamba profiles. Please use docker or singularity instead. We hope to add support for conda environments in the future.

[!WARNING] Please provide pipeline parameters via the CLI or Nextflow -params-file option. Custom config files including those provided by the -c Nextflow option can be used to provide any configuration except for parameters; see docs.

For more details and further functionality, please refer to the usage documentation and the parameter documentation.

Pipeline output

To see the results of an example test run with a full size dataset refer to the results tab on the nf-core website pipeline page. For more details about the output files and reports, please refer to the output documentation.

Credits

nf-core/pixelator was originally written for Pixelgen Technologies AB by:

  • Florian De Temmerman
  • Johan Dahlberg
  • Alvaro Martinez Barrio

Contributions and Support

If you would like to contribute to this pipeline, please see the contributing guidelines.

For further information or help, don't hesitate to get in touch on the Slack #pixelator channel (you can join with this invite).

Citations

If you use nf-core/pixelator for your analysis, please cite it using the following doi: 10.5281/zenodo.10015112

An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.

You can cite the nf-core publication as follows:

The nf-core framework for community-curated bioinformatics pipelines.

Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.

Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.

You can cite the molecular pixelation technology as follows:

Molecular pixelation: spatial proteomics of single cells by sequencing.

Filip Karlsson, Tomasz Kallas, Divya Thiagarajan, Max Karlsson, Maud Schweitzer, Jose Fernandez Navarro, Louise Leijonancker, Sylvain Geny, Erik Pettersson, Jan Rhomberg-Kauert, Ludvig Larsson, Hanna van Ooijen, Stefan Petkov, Marcela González-Granillo, Jessica Bunz, Johan Dahlberg, Michele Simonetti, Prajakta Sathe, Petter Brodin, Alvaro Martinez Barrio & Simon Fredriksson

Nat Methods. 2024 May 08. doi: 10.1038/s41592-024-02268-9

Owner

  • Name: nf-core
  • Login: nf-core
  • Kind: organization
  • Email: core@nf-co.re

A community effort to collect a curated set of analysis pipelines built using Nextflow.

Citation (CITATIONS.md)

# nf-core/pixelator: Citations

## [nf-core](https://pubmed.ncbi.nlm.nih.gov/32055031/)

> Ewels PA, Peltzer A, Fillinger S, Patel H, Alneberg J, Wilm A, Garcia MU, Di Tommaso P, Nahnsen S. The nf-core framework for community-curated bioinformatics pipelines. Nat Biotechnol. 2020 Mar;38(3):276-278. doi: 10.1038/s41587-020-0439-x. PubMed PMID: 32055031.

## [Nextflow](https://pubmed.ncbi.nlm.nih.gov/28398311/)

> Di Tommaso P, Chatzou M, Floden EW, Barja PP, Palumbo E, Notredame C. Nextflow enables reproducible computational workflows. Nat Biotechnol. 2017 Apr 11;35(4):316-319. doi: 10.1038/nbt.3820. PubMed PMID: 28398311.

## Pipeline tools

- [pixelator](https://doi.org/10.1038/s41592-024-02268-9)

  > Karlsson, F., Kallas, T., Thiagarajan, D. et al. “Molecular pixelation: spatial proteomics of single cells by sequencing.“ Nat Methods 21, 1044–1052 (2024). https://doi.org/10.1038/s41592-024-02268-9

- [cutadapt](http://dx.doi.org/10.14806/ej.17.1.200)

  > Martin, Marcel. “Cutadapt Removes Adapter Sequences from High-Throughput Sequencing Reads.” EMBnet.Journal 17, no. 1 (May 2, 2011): 10–12. https://doi.org/10.14806/ej.17.1.200.

- [fastp](https://doi.org/10.1002/imt2.107)

  > Chen, Shifu. “Ultrafast One-Pass FASTQ Data Preprocessing, Quality Control, and Deduplication Using Fastp.” IMeta 2, no. 2 (2023): e107. https://doi.org/10.1002/imt2.107.

## Software packaging/containerisation tools

- [Anaconda](https://anaconda.com)

  > Anaconda Software Distribution. Computer software. Vers. 2-2.4.0. Anaconda, Nov. 2016. Web.

- [Bioconda](https://pubmed.ncbi.nlm.nih.gov/29967506/)

  > Grüning B, Dale R, Sjödin A, Chapman BA, Rowe J, Tomkins-Tinch CH, Valieris R, Köster J; Bioconda Team. Bioconda: sustainable and comprehensive software distribution for the life sciences. Nat Methods. 2018 Jul;15(7):475-476. doi: 10.1038/s41592-018-0046-7. PubMed PMID: 29967506.

- [BioContainers](https://pubmed.ncbi.nlm.nih.gov/28379341/)

  > da Veiga Leprevost F, Grüning B, Aflitos SA, Röst HL, Uszkoreit J, Barsnes H, Vaudel M, Moreno P, Gatto L, Weber J, Bai M, Jimenez RC, Sachsenberg T, Pfeuffer J, Alvarez RV, Griss J, Nesvizhskii AI, Perez-Riverol Y. BioContainers: an open-source and community-driven framework for software standardization. Bioinformatics. 2017 Aug 15;33(16):2580-2582. doi: 10.1093/bioinformatics/btx192. PubMed PMID: 28379341; PubMed Central PMCID: PMC5870671.

- [Docker](https://dl.acm.org/doi/10.5555/2600239.2600241)

  > Merkel, D. (2014). Docker: lightweight linux containers for consistent development and deployment. Linux Journal, 2014(239), 2. doi: 10.5555/2600239.2600241.

- [Singularity](https://pubmed.ncbi.nlm.nih.gov/28494014/)

  > Kurtzer GM, Sochat V, Bauer MW. Singularity: Scientific containers for mobility of compute. PLoS One. 2017 May 11;12(5):e0177459. doi: 10.1371/journal.pone.0177459. eCollection 2017. PubMed PMID: 28494014; PubMed Central PMCID: PMC5426675.

GitHub Events

Total
  • Create event: 21
  • Issues event: 1
  • Release event: 1
  • Watch event: 2
  • Delete event: 17
  • Issue comment event: 34
  • Push event: 91
  • Pull request review comment event: 50
  • Pull request event: 55
  • Pull request review event: 63
  • Fork event: 2
Last Year
  • Create event: 21
  • Issues event: 1
  • Release event: 1
  • Watch event: 2
  • Delete event: 17
  • Issue comment event: 34
  • Push event: 91
  • Pull request review comment event: 50
  • Pull request event: 55
  • Pull request review event: 63
  • Fork event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 40
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 9 days
  • Total issue authors: 1
  • Total pull request authors: 5
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.8
  • Merged pull requests: 21
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 24
  • Average time to close issues: N/A
  • Average time to close pull requests: 9 days
  • Issue authors: 0
  • Pull request authors: 5
  • Average comments per issue: 0
  • Average comments per pull request: 0.79
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • fbdtemme (2)
Pull Request Authors
  • fbdtemme (35)
  • nf-core-bot (15)
  • johandahlberg (11)
  • mirpedrol (1)
  • ptajvar (1)
  • ambarrio (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/awsfulltest.yml actions
  • actions/upload-artifact v3 composite
  • seqeralabs/action-tower-launch v2 composite
.github/workflows/awstest.yml actions
  • actions/upload-artifact v3 composite
  • seqeralabs/action-tower-launch v2 composite
.github/workflows/branch.yml actions
  • mshick/add-pr-comment v1 composite
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • docker/login-action v2.2.0 composite
  • nf-core/setup-nextflow v1 composite
.github/workflows/clean-up.yml actions
  • actions/stale v7 composite
.github/workflows/fix-linting.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/linting.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • mshick/add-pr-comment v1 composite
  • nf-core/setup-nextflow v1 composite
  • psf/black stable composite
.github/workflows/linting_comment.yml actions
  • dawidd6/action-download-artifact v2 composite
  • marocchino/sticky-pull-request-comment v2 composite
modules/nf-core/cat/fastq/meta.yml cpan
modules/nf-core/custom/dumpsoftwareversions/meta.yml cpan
pyproject.toml pypi
.github/workflows/release-announcments.yml actions
  • actions/setup-python v4 composite
  • rzr/fediverse-action master composite
  • zentered/bluesky-post-action v0.0.2 composite