API reference#

This reference is generated from the docstrings of the installed rotifer package. The data access section is the curated entry point for the rotifer.db subpackage documented below.

Modules that cannot currently be imported are not listed here; see the issue tracker for the details.

Data access (rotifer.db)#

rotifer.db

Access biological sequence and annotation databases.

rotifer.db.core

Abstract base class for all database cursors.

rotifer.db.methods

Mixin classes shared by cursors of the same data type.

rotifer.db.delegator

Cursors that delegate data access to other cursors.

rotifer.db.parallel

Cursors that fetch data using parallel processes.

rotifer.db.cli

Reusable command line argument sets for database tools.

rotifer.db.ncbi

Access NCBI sequence, genome and taxonomy data.

rotifer.db.ncbi.entrez

Access NCBI databases through the Entrez E-utilities.

rotifer.db.ncbi.ftp

Access genome data from the NCBI FTP site.

rotifer.db.ncbi.mirror

Access genome data from a local mirror of the NCBI FTP site.

rotifer.db.ncbi.utils

Helper functions for identical protein group (IPG) reports.

rotifer.db.local

Access biological data stored on the local machine.

rotifer.db.local.easel

Fetch sequences from local FASTA files with Easel.

rotifer.db.local.ete3

Query the local NCBI Taxonomy database managed by the ETE toolkit.

rotifer.db.sql

Access biological data stored in SQL databases.

rotifer.db.sql.sqlite3

Fetch gene neighborhoods and identical protein group reports from local SQLite3 databases.

rotifer.db.uniprot

Access data hosted by UniProt.

rotifer.db.uniprot.webapi

Query UniProt's REST web services.

rotifer.db.uniprot.webapi.idmapping

Map database identifiers using UniProt's ID mapping REST service.

Core infrastructure#

rotifer

Rapid Open-source Tools and Infrastructure For data Exploration and Research

rotifer.core

Rotifer's core configuration and setup

rotifer.core.cli

rotifer.core.functions

rotifer.core.io.ftp

rotifer.core.loadpath

rotifer.core.log

rotifer.core.logger

rotifer.core.methods

rotifer.core.time

Genomes and annotation#

Sequence and interval utilities#

Data manipulation and taxonomy#

Other subpackages#