Bio2BEL miRTarBase¶
bio2bel_mirtarbase
can be installed easily from PyPI with the
following code in your favorite terminal:
$ python3 -m pip install bio2bel_mirtarbase
or from the latest code on GitHub with:
$ python3 -m pip install git+https://github.com/bio2bel/mirtarbase.git@master
Manager¶
Manager for Bio2BEL miRTarBase.
-
class
bio2bel_mirtarbase.manager.
Manager
(*args, **kwargs)[source]¶ miRNA-target interactions.
-
edge_model
¶
-
populate
(source: Optional[str] = None, update: bool = False) → None[source]¶ Populate database with the data from miRTarBase.
- Parameters
source – path or link to data source needed for
get_data()
update – Should HGNC an miRBase be updated?
-
list_evidences
() → List[bio2bel_mirtarbase.models.Evidence][source]¶ List the evidences in the database.
-
summarize
() → Mapping[str, int][source]¶ Return a summary dictionary over the content of the database.
-
query_mirna_by_mirtarbase_identifier
(mirtarbase_id: str) → Optional[bio2bel_mirtarbase.models.Mirna][source]¶ Get an miRNA by the miRTarBase interaction identifier.
- Parameters
mirtarbase_id – An miRTarBase interaction identifier
-
query_mirna_by_mirtarbase_name
(name: str) → Optional[bio2bel_mirtarbase.models.Mirna][source]¶ Get an miRNA by its miRTarBase name.
- Parameters
name – An miRTarBase name
-
query_mirna_by_hgnc_identifier
(hgnc_id: str) → Optional[bio2bel_mirtarbase.models.Mirna][source]¶ Query for a miRNA by its HGNC identifier.
- Parameters
hgnc_id – HGNC gene identifier
-
query_mirna_by_hgnc_symbol
(hgnc_symbol: str) → Optional[bio2bel_mirtarbase.models.Mirna][source]¶ Query for a miRNA by its HGNC gene symbol.
- Parameters
hgnc_symbol – HGNC gene symbol
-
query_target_by_entrez_id
(entrez_id: str) → Optional[bio2bel_mirtarbase.models.Target][source]¶ Query for one target.
- Parameters
entrez_id – Entrez gene identifier
-
query_target_by_hgnc_symbol
(hgnc_symbol: str) → Optional[bio2bel_mirtarbase.models.Target][source]¶ Query for one target.
- Parameters
hgnc_symbol – HGNC gene symbol
-
query_target_by_hgnc_identifier
(hgnc_id: str) → Optional[bio2bel_mirtarbase.models.Target][source]¶ Query for one target.
- Parameters
hgnc_id – HGNC gene identifier
-
enrich_rnas
(graph: pybel.struct.graph.BELGraph)[source]¶ Add all of the miRNA inhibitors of the RNA nodes in the graph.
-
Models¶
SQLAlchemy models for Bio2BEL miRTarBase.
-
class
bio2bel_mirtarbase.models.
Species
(**kwargs)[source]¶ Represents a species.
A simple constructor that allows initialization from kwargs.
Sets attributes on the constructed instance using the names and values in
kwargs
.Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.
-
taxonomy_id
¶ The NCBI taxonomy identifier
-
name
¶ The scientific name for the species
-
-
class
bio2bel_mirtarbase.models.
Mirna
(**kwargs)[source]¶ Create mirna table that stores information about the miRNA.
A simple constructor that allows initialization from kwargs.
Sets attributes on the constructed instance using the names and values in
kwargs
.Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.
-
name
¶ miRTarBase name
-
mirbase_id
¶ miRBase identifier
-
entrez_id
¶ Entrez Gene identifier
-
species_id
¶ The host species
-
-
class
bio2bel_mirtarbase.models.
Target
(**kwargs)[source]¶ Represents a target RNA.
A simple constructor that allows initialization from kwargs.
Sets attributes on the constructed instance using the names and values in
kwargs
.Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.
-
name
¶ Target gene name
-
entrez_id
¶ Entrez gene identifier
-
hgnc_symbol
¶ HGNC gene symbol
-
hgnc_id
¶ HGNC gene identifier
-
species_id
¶ The host species
-
serialize_to_entrez_node
() → pybel.dsl.node_classes.Rna[source]¶ Serialize to PyBEL node data dictionary.
-
-
class
bio2bel_mirtarbase.models.
Interaction
(**kwargs)[source]¶ Build Interaction table used to store miRNA and target relations.
A simple constructor that allows initialization from kwargs.
Sets attributes on the constructed instance using the names and values in
kwargs
.Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.
-
mirtarbase_id
¶ miRTarBase interaction identifier which is unique for a pair of miRNA and RNA targets
-
mirna_id
¶ The miRTarBase identifier of the interacting miRNA
-
target_id
¶ The Entrez gene identifier of the interacting RNA
-
-
class
bio2bel_mirtarbase.models.
Evidence
(**kwargs)[source]¶ Build Evidence table used to store MTI’s and their evidence.
A simple constructor that allows initialization from kwargs.
Sets attributes on the constructed instance using the names and values in
kwargs
.Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.
-
experiment
¶ Experiments made to find miRNA - target interaction. E.g. ‘Luciferase reporter assay//qRT-PCR//Western blot’
-
support
¶ Type and strength of the miRNA - target interaction. E.g. ‘Functional MTI (Weak)’
-
reference
¶ Reference PubMed Identifier
-
interaction_id
¶ The interaction for which this evidence was captured
-