This is a placeholder of a README. Full version will be released with the 1.0 version of the Mir-Us.
Fast, intuitive mirBase library, for solving problems with mirBase
To get Mir-Us to work, it is necessary to import miBase
package and then create a database object:
import miBase
m = miBase.MiRBase()
miRBase version can be specified while creating a new object:
import miBase
m = miBase.MiRBase(version="20")
Example of a full usage:
sample_gallus = m.get_mirna(mirna_id=["MIMAT0001185", "MIMAT0025825", "MIMAT0007451"])
print(sample_gallus)
More information about usage and technical aspects of the Mir-Us can be acquired in the docs page. Documentation includes:
- getting started guide
- user cookbook
- full compatibility description between versions of miRBase
- technical reference documentation from code
Docs page is not hosted externally yet, thus it must be initialised locally (instructions).
To access docs, a MkDocs, material theme for MkDocs and mkdocstrings package must be installed.
$ pip install mkdocs
$ pip install mkdocs-material
$ pip install mkdocstrings
To run docs, you have to be in the main directory of the Mir-Us and initialise the MkDocs. Then head to the localhost (https://127.0.0.1:8000/) and documentation should appear in your default web browser.
$ mkdocs serve
- Dudczak Kacper
- Michalczyk Maciej
- Dudczak Kacper
- Michalczyk Maciej
- Marta Wysocka
- Marek Żywicki