Skip to content

UNDER CONSTRUCTION: Mouse brain morphometry analysis pipeline for MRI imaging data

License

Notifications You must be signed in to change notification settings

drpatelh/nf-core-mrimorph

Repository files navigation

nf-core/mrimorph

Build Status GitHub Actions CI Status GitHub Actions Linting Status Nextflow

Docker

Introduction

nfcore/mrimorph is a bioinformatics pipeline used for the analysis of brain morphometry MRI imaging data.

The pipeline is built using Nextflow, a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It comes with docker containers making installation trivial and results highly reproducible.

Quick Start

i. Install nextflow

ii. Install one of docker or singularity.

iii. Download the pipeline and test it on a minimal dataset with a single command

nextflow run nf-core/mrimorph -profile test,<docker/singularity/institute>

Please check nf-core/configs to see if a custom config file to run nf-core pipelines already exists for your Institute. If so, you can simply use -profile institute in your command. This will enable either docker or singularity and set the appropriate execution settings for your local compute environment.

iv. Start running your own analysis!

nextflow run nf-core/mrimorph -profile <docker/singularity/institute> --input '*.img'

See usage docs for all of the available options when running the pipeline.

Documentation

The nf-core/mrimorph pipeline comes with documentation about the pipeline, found in the docs/ directory:

  1. Installation
  2. Pipeline configuration
  3. Running the pipeline
  4. Output and how to interpret the results
  5. Troubleshooting

Credits

The pipeline was originally written by The Bioinformatics & Biostatistics Group in collaboration with Jonny Kohl, Patty Wai and Bernard Siow from The Francis Crick Institute, London and Ma Da from Simon Fraser University, British Columbia, Canada.

The pipeline was developed by Harshil Patel.

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

Citation

You can cite the nf-core pre-print as follows:
Ewels PA, Peltzer A, Fillinger S, Alneberg JA, Patel H, Wilm A, Garcia MU, Di Tommaso P, Nahnsen S. nf-core: Community curated bioinformatics pipelines. bioRxiv. 2019. p. 610741. doi: 10.1101/610741.

About

UNDER CONSTRUCTION: Mouse brain morphometry analysis pipeline for MRI imaging data

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published