getHOG: Retrieve a HOG from the OMA Browser

In OmaDB: R wrapper for the OMA REST API

Description

The function retrieves a specific Hierarchical Orthologous Group (HOG) from the OMA Browser database. A HOG is a set of genes that have all decendet from a single ancestral gene at a specific taxonomic level.

Usage

getHOG(id, level = NULL, members = FALSE)

Arguments

id	an identifier for the HOG to be returned - either its HOG ID or a protein id.
level	a specific level for the HOG to be restricted to. level can either be 'root', or the name of a taxonomic level that is part of the HOG, e.g. 'Fungi'. By default it will retrieve the depest level of the most specific subhog for the given ID.
members	boolean that when set to TRUE returns a dataframe containg the protein members at a given hog level

Details

A HOG can be identified by its member proteins and a taxonomic level, or a HOG ID. As a taxonomic level, you can use either 'root' to retrieve the HOG at its deepest level, or the name of NCBI taxonomy level, or leave it out in which case the deepest level that doesn't include a duplication node is used.

The function either returns a single hog object or a list of hog objects. The later happens if the HOG ID you provide has already split into several sub-hogs at the level you indicate.

Value

an object containing HOG attributes, or a list of those

Examples

getHOG(id = 'YEAST590')
getHOG(id = 'YEAST590', level='root')
getHOG(id = 'YEAST590', level='Saccharomycetaceae', members=TRUE)

Example output

Loading required package: httr
Loading required package: plyr

Cannot resolve 'https://omabrowser.org/api/hog/YEAST590/?per_page=5000&page=1'. Please connect to the internet
NULL
Cannot resolve 'https://omabrowser.org/api/hog/YEAST590/?level=root&per_page=5000&page=1'. Please connect to the internet
NULL
Cannot resolve 'https://omabrowser.org/api/hog/YEAST590/members/?level=Saccharomycetaceae&per_page=5000&page=1'. Please connect to the internet
NULL

OmaDB documentation built on Nov. 13, 2020, 2 a.m.