From 31362b9f7cbca938cddaf0c5528d70edb2153a13 Mon Sep 17 00:00:00 2001
From: teslajoy
API calls are avaialble @ https://reactome.org/AnalysisService/#/
Data model key classes for id query are available @ https://reactome.org/documentation/data-model
-reactome2py.analysis.compare_species(species='48892', page_size='1', page='1', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL', p_value='1')¶reactome2py.analysis.compare_species(species='48892', page_size='1', page='1', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL', p_value='1')¶
Compares Homo sapiens to the specified species
reactome2py.analysis.db_name()¶The name of current database
@@ -74,7 +75,7 @@reactome2py.analysis.db_version()¶The version number of current database
@@ -85,9 +86,9 @@reactome2py.analysis.found_entities(token, path='', resource='TOTAL', file='result.csv', save=False, chunk_size=128)¶reactome2py.analysis.found_entities(token, path='', resource='TOTAL', file='result.csv', save=False, chunk_size=128)¶
list of found entities in reactome database
reactome2py.analysis.identifier(id='EGFR', interactors=False, page_size='1', page='1', species='Homo Sapiens', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None, projection=False)¶reactome2py.analysis.identifier(id='EGFR', interactors=False, page_size='1', page='1', species='Homo Sapiens', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None, projection=False)¶
Given a protein, gene, or small molecule identifier symbol conducts analysis of the identifier over different species and pathways in reactome database.
reactome2py.analysis.identifiers(ids='EGF, EGFR', interactors=False, page_size='1', page='1', species='Homo Sapiens', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None, projection=False)¶reactome2py.analysis.identifiers(ids='EGF,EGFR', interactors=False, page_size='1', page='1', species='Homo Sapiens', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None, projection=False)¶
Given a list of protein, gene, or small molecule identifiers conducts reactome pathway enrichment analysis.
reactome2py.analysis.identifiers_form(path, interactors=False, page_size='1', page='1', species='Homo Sapiens', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None, projection=False)¶reactome2py.analysis.identifiers_form(path, interactors=False, page_size='1', page='1', species='Homo Sapiens', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None, projection=False)¶
Given a file path with a list of identifiers conducts reactome pathway enrichment analysis
reactome2py.analysis.identifiers_mapping(ids='EGF, EGFR', interactors=False, projection=False)¶reactome2py.analysis.identifiers_mapping(ids='EGF,EGFR', interactors=False, projection=False)¶
Maps the identifiers passed as a comma seperated list in str format over the different species and if projection is set to true, projects the result to Homo Sapiens
reactome2py.analysis.identifiers_mapping_form(path, interactors=False, projection=False)¶reactome2py.analysis.identifiers_mapping_form(path, interactors=False, projection=False)¶
Maps the identifiers passed via txt file over the different species and if projection is set to true, projects the result to Homo Sapiens
reactome2py.analysis.identifiers_mapping_url(external_url, interactors=False, projection=False)¶reactome2py.analysis.identifiers_mapping_url(external_url, interactors=False, projection=False)¶
Maps the identifiers passed via url over the different species and if projection is set to true, projects the result to Homo Sapiens
reactome2py.analysis.identifiers_url(external_url, interactors=False, page_size='1', page='1', species='Homo Sapiens', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None, projection=False)¶reactome2py.analysis.identifiers_url(external_url, interactors=False, page_size='1', page='1', species='Homo Sapiens', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None, projection=False)¶
Given a url with a list of identifiers conducts reactome pathway enrichment analysis
reactome2py.analysis.import_form(input_file)¶reactome2py.analysis.import_form(input_file)¶
Imports the posted json file into the service The accepted format is the same as provided by the method /#/download/{token}/result.json. Note: The submitted file can be gzipped.
reactome2py.analysis.import_json(input_json)¶reactome2py.analysis.import_json(input_json)¶
Imports the posted json into the service The accepted format is the same as provided by the method /#/download/{token}/result.json. Note: The provided file can be gzipped.
reactome2py.analysis.import_url(input_url)¶reactome2py.analysis.import_url(input_url)¶
Imports the json file provided by the posted url into the service The accepted format is the same as provided by the method /#/download/{token}/result.json. Note: The provided file can be gzipped.
reactome2py.analysis.pathway2df(token, path='', resource='TOTAL', file='result.csv', save=False, chunk_size=128)¶reactome2py.analysis.pathway2df(token, path='', resource='TOTAL', file='result.csv', save=False, chunk_size=128)¶
Create a Data frame of the analysis result for all the pathway hits - save to csv file (comma separated)
reactome2py.analysis.report(token, path, file='report.pdf', number='25', resource='TOTAL', diagram_profile='Modern', analysis_profile='Standard', fireworks_profile='Barium Lithium', species='Homo sapiens', chunk_size=128)¶reactome2py.analysis.report(token, path, file='report.pdf', number='25', resource='TOTAL', diagram_profile='Modern', analysis_profile='Standard', fireworks_profile='Barium Lithium', species='Homo sapiens', chunk_size=128)¶
Downloads a report for a given pathway analysis result
reactome2py.analysis.result2json(token, path='', file='result.json', save=False, gzip=False, chunk_size=128)¶reactome2py.analysis.result2json(token, path='', file='result.json', save=False, gzip=False, chunk_size=128)¶
View of analysis result in json format
reactome2py.analysis.token(token, species='Homo sapiens', page_size='1', page='1', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None)¶reactome2py.analysis.token(token, species='Homo sapiens', page_size='1', page='1', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None)¶
Returns the result associated with token. Use page and pageSize to reduce the amount of data retrieved. Use sortBy and order to sort the result by your preferred option. The resource field will filter the results to show only those corresponding to the preferred molecule type (TOTAL includes all the different molecules type)
@@ -439,9 +440,9 @@reactome2py.analysis.token_filter_species(token, species='Homo sapiens', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL')¶reactome2py.analysis.token_filter_species(token, species='Homo sapiens', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL')¶
Queries analysis token and returns and filters the result by species
reactome2py.analysis.token_pathway_page(token, pathway, page_size='1', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None)¶reactome2py.analysis.token_pathway_page(token, pathway, page_size='1', sort_by='ENTITIES_FDR', order='ASC', resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None)¶
Returns the page where the corresponding pathway is taking into account the passed parameters
reactome2py.analysis.token_pathway_reactions(token, pathway, resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None)¶reactome2py.analysis.token_pathway_reactions(token, pathway, resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None)¶
Returns the reaction ids a or one pathway's stable identifiers (stId) that is present in the original result
reactome2py.analysis.token_pathway_summary(token, pathway, resource='TOTAL', page='1', page_size='1', by='all')¶reactome2py.analysis.token_pathway_summary(token, pathway, resource='TOTAL', page='1', page_size='1', by='all')¶
by='all': all the contained identifiers and interactors
reactome2py.analysis.token_pathways_binned(token, resource='TOTAL', bin_size='100', p_value='1', include_disease=True)¶reactome2py.analysis.token_pathways_binned(token, resource='TOTAL', bin_size='100', p_value='1', include_disease=True)¶
Returns a list of binned hit pathway sizes associated with the token
reactome2py.analysis.token_pathways_reactions(token, pathways, resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None)¶reactome2py.analysis.token_pathways_reactions(token, pathways, resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None)¶
Returns the reaction ids of all the pathway stable identifiers (stIds) that are present in the original result
reactome2py.analysis.token_pathways_result(token, pathways, species='Homo sapiens', resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None)¶reactome2py.analysis.token_pathways_result(token, pathways, species='Homo sapiens', resource='TOTAL', p_value='1', include_disease=True, min_entities=None, max_entities=None)¶
For a given list of pathway stable identifiers (stId) it will query and retrieve a list containing those that are present in the result (with the results for the indicated molecule type)
reactome2py.analysis.token_pathways_summary(token, pathways, resource='TOTAL')¶reactome2py.analysis.token_pathways_summary(token, pathways, resource='TOTAL')¶
Queries analysis token and returns a summary of the contained identifiers and interactors for all pathways
reactome2py.analysis.token_resources(token)¶reactome2py.analysis.token_resources(token)¶
the resources summary associated with the token
reactome2py.analysis.token_unfound_identifiers(token, page_size='1', page='1')¶reactome2py.analysis.token_unfound_identifiers(token, page_size='1', page='1')¶
Returns a list of the identifiers not found for a given token
reactome2py.analysis.unfound_entities(token, path='', file='result.csv', save=False, chunk_size=128)¶reactome2py.analysis.unfound_entities(token, path='', file='result.csv', save=False, chunk_size=128)¶
list of unfound entities in reactome database
' + _('Hide Search Matches') + '
') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box or textarea + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/docs/build/_static/documentation_options.js b/docs/build/_static/documentation_options.js new file mode 100644 index 0000000..5a94801 --- /dev/null +++ b/docs/build/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '2.0.0', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/docs/build/_static/file.png b/docs/build/_static/file.png new file mode 100644 index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3 GIT binary patch literal 286 zcmV+(0pb3MP)