Skip to main content

PM4NGS: Program manager for NGS data analysis

Python package Python application Upload Python Package Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge

PM4NGS is designed to generate a standard organizational structure for Next Generation Sequencing (NGS) data analysis including directory structures for the project, Jupyter notebooks for data management and CWL workflows for the 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 recommend reading this manuscript for a better understanding of the guiding principles of the PM4NGS project.

The project is composed of three parts:

  • the project organizational structure which defines standard files and directories for the project
  • the Jupyter Notebook which is a user interface for the data management and the visualization of results
  • the CWL workflow that executes 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

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.

Metadata

Release files for pm4ngs 0.1.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pm4ngs 0.1.6
File Size Uploaded Provenance Actions
pm4ngs-0.1.6.tar.gz 23.7 kB Without provenance Details for pm4ngs-0.1.6.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pm4ngs 0.1.6
File Interpreter ABI Platform Actions
pm4ngs-0.1.6-py3-none-any.whl Python 3 none any Details for pm4ngs-0.1.6-py3-none-any.whl

Total release size: 57.8 kB

Release files / pm4ngs-0.1.6.tar.gz

Download URL pm4ngs-0.1.6.tar.gz
Size 23.7 kB
Tags Source
SHA-256 checksum
How to use checksums
bbabbbe6575dd4c0cbb062e624e3e89069d5b28c4db3f9d1006080e560eb0085
BLAKE2b-256 checksum
How to use checksums
ae21903c40c02d27ae52073e3f123536d50a3f96f020c43817e0d670c31b50b0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.3.4 CPython/3.14.3 Linux/6.17.0-1010-azure

Release files / pm4ngs-0.1.6-py3-none-any.whl

Download URL pm4ngs-0.1.6-py3-none-any.whl
Size 34.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
464ac89e833b330d95b386cf96df4b0eb025e9602c631f3e7f85e76bcf3a8692
BLAKE2b-256 checksum
How to use checksums
ac3e495c1f2d0ae7ef259a68f5df2003915c05208d7fe951ca303fcd2d633cb0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.3.4 CPython/3.14.3 Linux/6.17.0-1010-azure

Security for pm4ngs 0.1.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page