Skip to main content

PM4NGS generates a standard organizational structure for Next Generation Sequencing (ngs) data analysis

Project description

PM4NGS: Program manager for NGS data analysis

Python package Python application Upload Python Package

PM4NGS is designed to generate a standard organizational structure for Next-generation Sequencing data analysis including a directory structure for the project, Jupyter notebooks for data management and CWL workflows for pipeline execution.

Our work was inspired for a paper published by Prof. William Noble in 2009: A Quick Guide to Organizing Computational Biology Projects. We strongly recommend reading this paper for a better understanding of the guiding principles of this project.

The projects are composed of three main parts. The first one is the project organizational structure which define a standard files and directories for the project. The second part are Jupyter Notebooks as user interfaces for data management and visualization. The third part are the CWL workflows that execute the data analysis.

PM4NGS source code includes the templates used by cookiecutter to generate the project organizational structure and the Jupyter notebooks. The CWL workflows are defined in a separate GitHub project named: cwl-ngs-workflows-cbb.

Powered by Cookiecutter, Jupyter Notebook, CWL, Docker, Conda and Bioconda.

Documentation

Go to https://pm4ngs.readthedocs.io for more detail information.

Reference

Vera Alvarez R, Pongor LS, Mariño-Ramírez L and Landsman D. Containerized open-source framework for NGS data analysis and management [version 1; not peer reviewed]. F1000Research 2019, 8(ISCB Comm J):1229 (poster) (doi: 10.7490/f1000research.1117155.1)

Features

  • NGS data integration, management and analysis based on Jupyter notebook, CWL workflows and cookiecutter project templates
  • Easy installation and use with a minimum command line interaction.
  • Data analysis CWL workflows executed from the Jupyter notebook with automatic failing detection and validated with published data
  • CWL workflows and Jupyter Notebooks ready for cloud computing
  • Project reports and dynamic content creation after data processing using CWL workflows
  • Optional use of Docker/Biocontainers or Conda/Bioconda for Bioinformatics tool installation and management

External dependencies

  • poppler

Public Domain notice

National Center for Biotechnology Information.

This software is a "United States Government Work" under the terms of the United States Copyright Act. It was written as part of the authors' official duties as United States Government employees and thus cannot be copyrighted. This software is freely available to the public for use. The National Library of Medicine and the U.S. Government have not placed any restriction on its use or reproduction.

Although all reasonable efforts have been taken to ensure the accuracy and reliability of the software and data, the NLM and the U.S. Government do not and cannot warrant the performance or results that may be obtained by using this software or data. The NLM and the U.S. Government disclaim all warranties, express or implied, including warranties of performance, merchantability or fitness for any particular purpose.

Please cite NCBI in any work or product based on this material.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pm4ngs, version 0.0.6
Filename, size File type Python version Upload date Hashes
Filename, size pm4ngs-0.0.6-py3-none-any.whl (30.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pm4ngs-0.0.6.tar.gz (13.3 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page