GithubHelp home page GithubHelp logo

nf-core / nanostring Goto Github PK

View Code? Open in Web Editor NEW
12.0 153.0 6.0 2.92 MB

An analysis pipeline for Nanostring nCounter expression data.

Home Page: https://nf-co.re/nanostring

License: MIT License

HTML 1.44% Python 5.78% Nextflow 45.03% Groovy 28.94% R 18.80%
nf-core nextflow workflow pipeline nanostring nanostringnorm

nanostring's Introduction

nf-core/nanostring nf-core/nanostring

GitHub Actions CI Status GitHub Actions Linting Status AWS CICite with Zenodo

Nextflow run with conda run with docker run with singularity Launch on Nextflow Tower

Get help on SlackFollow on TwitterFollow on MastodonWatch on YouTube

Introduction

nf-core/nanostring is a bioinformatics pipeline that can be used to analyze NanoString data. The performed analysis steps include quality control and data normalization.

The pipeline is built using Nextflow, a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It uses Docker/Singularity containers making installation trivial and results highly reproducible. The Nextflow DSL2 implementation of this pipeline uses one container per process which makes it much easier to maintain and update software dependencies. Where possible, these processes have been submitted to and installed from nf-core/modules in order to make them available to all nf-core pipelines, and to everyone within the Nextflow community!

On release, automated continuous integration tests run the pipeline on a full-sized dataset on the AWS cloud infrastructure. This ensures that the pipeline runs on AWS, has sensible resource allocation defaults set to run on real-world datasets, and permits the persistent storage of results to benchmark between pipeline releases and other analysis sources.The results obtained from the full-sized test can be viewed on the nf-core website.

Pipeline summary

  1. Quality control with NACHO (NACHO)
  2. Perform normalization with NACHO
  3. Create count tables with provided metadata
  4. Present QC for NanoString data (MultiQC)

Pipeline tubemap

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:

samplesheet.csv:

RCC_FILE,RCC_FILE_NAME,SAMPLE_ID
/path/to/sample1.RCC,sample1.RCC,sample1
/path/to/sample2.RCC,sample2.RCC,sample2

Each row represents a RCC file with counts.

Now, you can run the pipeline using:

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

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/nanostring was originally written by Peltzer, Alexander & Mohr, Christopher. Extensive support was provided from other co-authors on the scientific or technical input required for the pipeline:

  • Stadermann, Kai
  • Zwick, Matthias
  • Leparc, Germán
  • Schmid, Ramona

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 #nanostring channel (you can join with this invite).

Citations

If you use nf-core/nanostring for your analysis, please cite the publication: nf-core/nanostring Bioinformatics and the Zenodo DOI.

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.

nanostring's People

Contributors

apeltzer avatar christopher-mohr avatar grst avatar jemten avatar nf-core-bot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

nanostring's Issues

Option to remove timestamp from result files

Description of feature

At the moment the pipeline produces some results files (e.g. count matrices) with a preceding timestamp. Would be great if there was at least an option to omit the timestamp.

Add pipeline map to docs

Description of feature

With one of the next releases we should add the pipeline map to the README since we already created one anyway.

CREATE_GENE_HEATMAP fails if additional columns present in input sample sheet

Description of the bug

The following line to extract gene names automatically will fail if additional columns present in sample annotation:

https://github.com/nf-core/nanostring/blob/1.2.1/bin/compute_gene_heatmap.R -->

gene_cols <- counts %>% dplyr::select(- any_of(c(unique(c("SAMPLE_ID", id_col)), "RCC_FILE", "TIME", "TREATMENT", "OTHER_METADATA")))

Command used and terminal output

No response

Relevant files

No response

System information

No response

AWS Full tests not shown at nf-core

Description of the bug

AWS Full tests not shown at nf-core

Command used and terminal output

No response

Relevant files

No response

System information

No response

NACHO (qc) report not published

Description of the bug

Currently, the *.html report that is generated by NACHO is not defined as output file since it is commented out here:

//path "*.html", emit: nacho_qc_reports

Command used and terminal output

No response

Relevant files

No response

System information

No response

Allow Skippnig heatmap functionality

Description of the bug

Currently this is not supported

Command used and terminal output

No response

Relevant files

No response

System information

No response

Update NACHO R package

Description of the bug

The current version of the package has a bug with respect to the QC metric plotting as reported here.

Once available on CRAN we should update to v2.0.5. This will also include the mulled containers at biocontainers.

Command used and terminal output

No response

Relevant files

No response

System information

No response

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.