mieaa.API¶

class mieaa.API¶

miEAA api wrapper class. Each instance is tied to a Job ID after starting an enrichment analysis. Instance must be reset with new_session() before starting a new analysis.

root_url [class attribute]

API root url

Type:	str

api_version [class attribute]

Current API version

Type:	str

endpoints [class attribute]

API endpoints suffix

Type:	dict

wait_between_requests [class attribute]

How many seconds to wait between API requests (due to throttling)

Type:	float

default [class attribute]

Default settings to pass to converter or analysis apis

Type:	dict

jobs [class attribute]

Access jobs run by any API instances, keys are job_id and values are enrichment parameters

Type:	dict

session [instance attribute]

Session information necessary to retrieve results

Type:	API_Session

job_id [instance attribute]

Unique identifier for enrichment analysis job of current session

Type:	uuid

__init__()¶: Initialize self. See help(type(self)) for accurate signature.

Methods

`__init__`()	Initialize self.
`convert_mirbase`(mirnas, Iterable[str], IO], …)	Convert a set of either miRNAs/precursors from one miRbase version to another
`get_enrichment_categories`(mirna_type, species)	Get possible enrichment categories
`get_enrichment_parameters`()	Retrieve parameters used during enrichment analysis
`get_gui_url`(page[, job_id])	Get specific url to page in web tool
`get_gui_urls`([job_id])	Retrieve important mieaa webtool urls
`get_progress`()	Retrieve enrichment analysis progress
`get_results`(results_format, …[, retries])	Return results in json or csv format
`invalidate`()	Invalidate current session.
`load_job`(job_id)
`new_session`()	Start a new session, clearing all job results
`open_gui`([page, job_id])	Open specific mieaa web tool page in browser
`run_gsea`(test_set, Iterable[T_co], IO], …)	Start miRNA Set Enrichment Analysis
`run_ora`(test_set, Iterable[T_co], IO], …)	Start Over Enrichment Analysis
`save_enrichment_results`(save_file, IO], …)	Save results in specified format
`to_mirna`(mirnas, Iterable[str], IO], …)	Convert from precursor->mirna
`to_precursor`(mirnas, Iterable[str], IO], …)	Convert from mirna->precursor

Attributes

`api_version`
`default_params`
`endpoints`
`jobs`
`root_url`
`wait_between_requests`