https://github.com/broadinstitute/poolq
The Genetic Perturbation Platform's tool for deconvoluting and quantifying the results of pooled screens
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary
Repository
The Genetic Perturbation Platform's tool for deconvoluting and quantifying the results of pooled screens
Basic Info
- Host: GitHub
- Owner: broadinstitute
- License: other
- Language: Scala
- Default Branch: main
- Size: 3.58 MB
Statistics
- Stars: 5
- Watchers: 7
- Forks: 1
- Open Issues: 9
- Releases: 10
Metadata Files
README.md
PoolQ 3.0
Copyright (c) 2025 Genetic Perturbation Platform, The Broad Institute of Harvard and MIT.
Overview
PoolQ is a counter for indexed samples from next-generation sequencing of pooled DNA. Given a set of sequencing data files (FASTQ, SAM, or BAM), and a pair of reference files mapping DNA barcodes to construct or experimental identifiers, PoolQ reads the sequencing data and tallies the co-occurrence of each pair of barcodes from the two files, yielding a two-dimensional histogram. The barcodes in one reference file are treated as rows in the histogram; the other correspond to columns.
PoolQ is capable of locating barcodes within reads using a variety of techniques:
- Fixed location
- Known DNA prefix
- Template matching
It matches barcodes to reference data either exactly or allowing up to one base of mismatch. Currently, PoolQ does not support matching with gaps or deletions.
In addition to producing a histogram, PoolQ generates a number of reports, which contain statistics and other information that can be used to troubleshoot experiments. These include match percentages, barcode locations, matching correlations between barcodes, and lists of frequently-occurring unknown barcodes.
Documentation
For information on how to run PoolQ and its various modes and options, please see the manual. We also maintain a changelog listing updates made to PoolQ.
As of version 3.5.0, the source code to PoolQ is available under a BSD 3-clause license. We welcome contributions to PoolQ and have created a contributor guide. Additionally, we maintain a list of other open-source libraries PoolQ depends on, along with links to associated licenses.
Changes in PoolQ 3
PoolQ was completely rewritten for version 3. The new code is faster and the codebase is much cleaner and more maintainable. We have taken the opportunity to make other changes to PoolQ as well.
- There are substantial changes to the command-line interface for the program.
- The default counts file format has changed slightly, although there is a command-line argument that indicates that PoolQ 3 should write a backwards-compatible counts file. The differences are in headers only; file parsers should be able to adapt easily.
- The quality file has changed somewhat. Importantly, the definition of certain statistics has changed slightly, so quality metrics cannot be directly compared between the the new and old versions. In addition, we no longer provide normalized match counts.
See the manual for complete details on the differences versions 2 and 3.
PoolQ 2 support
We will continue to make the PoolQ 2.4 artifacts available for download on the GPP portal. We have no plans to add features to the code. We will address bugs on a case-by-case basis; in general only critical bugfixes will be ported to versions prior to 2.4, effective immediately.
Maintainers
PoolQ is developed and maintained by the Broad Institute Genetic Perturbation Platform.
Contact Us
To report a problem with PoolQ, please use the GitHub issue tracking system. For all other inquiries, please contact us via https://portals.broadinstitute.org/gppx/portals/broad/contactus
Owner
- Name: Broad Institute
- Login: broadinstitute
- Kind: organization
- Location: Cambridge, MA
- Website: http://www.broadinstitute.org/
- Twitter: broadinstitute
- Repositories: 1,083
- Profile: https://github.com/broadinstitute
Broad Institute of MIT and Harvard
GitHub Events
Total
- Create event: 3
- Release event: 1
- Issues event: 1
- Watch event: 1
- Delete event: 4
- Push event: 6
- Pull request review event: 1
- Pull request event: 6
Last Year
- Create event: 3
- Release event: 1
- Issues event: 1
- Watch event: 1
- Delete event: 4
- Push event: 6
- Pull request review event: 1
- Pull request event: 6
Issues and Pull Requests
Last synced: 9 months ago
All Time
- Total issues: 1
- Total pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: about 1 hour
- Total issue authors: 1
- Total pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: about 1 hour
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- mtomko (2)
Pull Request Authors
- mtomko (10)
- tmgreen (1)
- rnaiserv (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v3.1.0 composite
- actions/setup-java v3.6.0 composite
- jrouly/scalafmt-native-action v2 composite
- actions/checkout v3.1.0 composite
- actions/setup-java v3.6.0 composite
- jrouly/scalafmt-native-action v2 composite