Skip to main content

BROCC

Generate consensus-based taxonomic assignments from BLAST results.

Please cite the following paper when using BROCC:

Dollive S, Peterfreund GL, Sherrill-Mix S, Bittinger K, Sinha R, Hoffmann C, Nabel CS, Hill DA, Artis D, Bachman MA, Custers-Allen R, Grunberg S, Wu GD, Lewis JD, Bushman FD. A tool kit for quantifying eukaryotic rRNA gene sequences from human microbiome samples. Genome Biol. 2012 Jul 3;13(7):R60. doi: 10.1186/gb-2012-13-7-r60.

Installion

To install BROCC, run this command in the current directory.

pip install .

BROCC has two methods of looking up taxon names: it can use a local copy of the NCBI taxonomy, or it can use NCBI's E-utilities to ask for names over the web. Using a local copy of the NCBI taxonomy is much faster and more reliable. To prepare this taxonomy database, use the command:

create_local_taxonomy_db.py

You will need about 5G for the taxonomy databaase, which is stored at ~/.brocc/taxonomy.db by default.

Running

The BROCC classifier takes BLAST results as input, using output format 7 (see BLAST documentation). The following BLAST parameters are found to work best for amplicon-based sequence sets:

blastn -query <SEQUENCES (FASTA FORMAT)> -evalue 1e-5 -outfmt 7 -db nt -out <BLAST RESULTS> -num_threads 8 -max_target_seqs 100

The BROCC program requires two input files and the name of an output directory:

brocc.py -i <SEQUENCES (FASTA FORMAT)> -b <BLAST RESULTS> -o <OUTPUT DIRECTORY>

brocc.py outputs a QIIME-formated taxonomy map and a couple of log files, giving details on the voting.

Settings

The BROCC command has several options for consensus formation:

  • minimum hit coverage (for consideration)
  • minimum species identity (for consideration at the species level)
  • minimum genus identity (for consideration at the genus level)

The defaults are currently set for the ITS1 gene, because these settings seem to work well over several different amplicons. The minimum identity defaults for ITS1 are 95.2% at the species level and 83.05% at the genus level (taken from Liggenstoffer et al). For 18S, settings of 99.0% at the species level and 96.0% at the genus level seem to produce the most accurate and stable assignments.

Metadata

Release files for brocc 1.4.0

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

Built distribution (wheel)

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

Release files / brocc-1.4.0-py3-none-any.whl

Download URL brocc-1.4.0-py3-none-any.whl
Size 13.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
be799bbbb5b5549d46da98b2695b7c47d3305022cb5ae9778de558b09d3094b0
BLAKE2b-256 checksum
How to use checksums
080b5d21397b377fae075e80dfcfe60329165b25f1d4017313ca6418a7cd7052
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.14.2 setuptools/40.4.2 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.2

Security for brocc 1.4.0

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.

Release history Release notifications | RSS feed

This release

1.4.0 This release

1 release file No provenance

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