GMGC-mapper
Command line tool to query the Global Microbial Gene Catalog (GMGC).
Install
GMGC-mapper runs on Python 3.6-3.8 and requires prodigal to be available for genome mode.
Conda install
The easiest way to install GMGC-mapper is through bioconda, which will ensure
all dependencies (including prodigal) are installed automatically:
conda install -c bioconda gmgc-mapper
pip install
Alternatively, GMGC-mapper is available from PyPI, so can be installed
through pip:
pip install GMGC-mapper
Note that this does not install prodigal (which is necessary for the
genome-based workflow).
Install from source
Finally, especially if you are retrieving the cutting edge version from Github, you can install with the standard
python setup.py install
Examples
- Input is a genome sequence.
gmgc-mapper -i input.fasta -o output
- Input is DNA/protein gene sequences
gmgc-mapper --nt-genes genes.fna --aa-genes genes.faa -o output
The nucleotide input is optional (but should be used if available so that the quality of the hits can be refined):
gmgc-mapper --aa-genes genes.faa -o output
If yout input is a metagenome, you can use NGLess for assembly and gene prediction. For more details, read the docs.
Output
The output folder will contain
- Outputs of gene prediction (prodigal).
- Complete data table, listing all the hits in GMGC, per gene.
- Complete table, listing all the genome bins (MAGs) that are found in the results.
- Human readable summary.
For more details, read the docs. A description of the outputs is also written to output folder for convenience.
Parameters
-
-i/--input: path to the input genome file(.fasta/.gz/.bz2). -
-o/--output: Output directory (will be created if non-existent). -
--nt-genes: path to the input DNA gene file(.fasta/.gz/.bz2). -
--aa-genes: path to the input Protein gene file(.fasta/.gz/.bz2).
Metadata
Release files for GMGC-mapper 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| GMGC-mapper-0.2.0.tar.gz | 13.7 kB | Without provenance | Details for GMGC-mapper-0.2.0.tar.gz |
Release files / GMGC-mapper-0.2.0.tar.gz
| Download URL | GMGC-mapper-0.2.0.tar.gz |
|---|---|
| Size | 13.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
49977835cd3af85c3ed45ba4fd2c173ad94249a9e90c56599cc342c95a001da6
|
|
BLAKE2b-256 checksum How to use checksums |
27b94f686f1e3f43b0432d4fd63c888833e776fd828e8f602bfecb2265b331a2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.4.2 requests/2.20.1 setuptools/40.4.0 requests-toolbelt/0.9.1 tqdm/4.26.0 CPython/3.6.8
|
Security for GMGC-mapper 0.2.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.