Skip to main content

MAGeCK2: Model-based Analysis of Genome-wide CRISPR-Cas9 Knockout screens

Project description

MAGeCK2: Model-based Analysis of CRISPR screens

CI PyPI License: BSD-3-Clause

MAGeCK2 is a new computational tool, built upon MAGeCK, for CRISPR screening analysis.

Compared with MAGeCK, MAGeCK2 highlights the following additional functionalities:

  • Paired sample analysis
  • Processing and analyzing screens with UMIs
  • Processing and analyzing paired-guide screens

See ROADMAP.md for the planned direction of the project.

MAGeCK2 is compatible with the lagacy MAGeCK. Everything is unchanged -- just need to switch the command from "mageck" to "mageck2".

Installation

MAGeCK2 requires Python ≥ 3.7 and a C++ compiler (used to build the bundled RRA component; g++ on Linux or clang++ on macOS, plus make). The Python dependencies (numpy, scipy, pandas, matplotlib, statsmodels) are installed automatically.

Install the latest release from PyPI:

pip install mageck2

To install the latest development version directly from GitHub:

pip install git+https://github.com/davidliwei/mageck2.git

or from a local clone:

git clone https://github.com/davidliwei/mageck2.git
cd mageck2
pip install .

For detailed instructions, see mageck2-doc.

Quick start

Run a statistical test from a count table:

mageck2 test -k count_table.txt -t treatment_samples -c control_samples -n output_prefix

Runnable example datasets are available in the mageck2-demo repository.

Documentation

For instructions on installation, usage and running examples, see mageck2-doc.

MAGeCK

The older version of MAGeCK can be accessed via sourceforge or bitbucket.

Contributing

Contributions are welcome. See CONTRIBUTING.md for how to get started, GOVERNANCE.md for how the project is run, and ROADMAP.md for where it is headed.

Questions

Questions? Bug? Recommendations? Here are a few ways:

Version history

2026 — Version 0.2.0: Packaging modernization

  • First release published to PyPI: pip install mageck2.
  • Migrated packaging to pyproject.toml; MAGeCK2 is now pip-installable on Python 3.7+ (including 3.12 and 3.13).
  • Added continuous integration and a smoke-test suite.
  • Added project governance and contribution documentation.

See CHANGELOG.md for the full list of changes.

2020.12.01 Version 0.1

  • Add paired-guide support in count command
  • Add UMI support in count command
  • The source code released.

Project details


Download files

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

Source Distribution

mageck2-0.2.0.tar.gz (399.0 kB view details)

Uploaded Source

File details

Details for the file mageck2-0.2.0.tar.gz.

File metadata

  • Download URL: mageck2-0.2.0.tar.gz
  • Upload date:
  • Size: 399.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mageck2-0.2.0.tar.gz
Algorithm Hash digest
SHA256 fd53977b8b60153bd24bb01c7a1d35e1617285b57ecd4c4a3a9a936e353cbd8f
MD5 a99a431600ee599ed7072583b5bc4b37
BLAKE2b-256 0df3c836e183e84ee6f50bcb3fcf8d82adbac5c1c305e8534f51bd278d1c1d51

See more details on using hashes here.

Provenance

The following attestation bundles were made for mageck2-0.2.0.tar.gz:

Publisher: release.yml on davidliwei/mageck2

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page