getCellBaseResourceHelp: getCellBaseResourceHelp

View source: R/commons.R

getCellBaseResourceHelpR Documentation

getCellBaseResourceHelp

Description

A function to get help about available cellbase resources

Usage

getCellBaseResourceHelp(object, subcategory)

Arguments

object

a cellBase class object

subcategory

a character the subcategory to be queried

Details

This function retrieves available resources for each generic method like getGene, getRegion, getprotein, etc. It help the user see all possible resources to use with the getGeneric methods

Value

character vector of the available resources to that particular subcategory

Examples

cb <- CellBaseR()
# Get help about what resources are available to the getGene method
getCellBaseResourceHelp(cb, subcategory="gene")
# Get help about what resources are available to the getRegion method
getCellBaseResourceHelp(cb, subcategory="region")
# Get help about what resources are available to the getXref method
getCellBaseResourceHelp(cb, subcategory="id")

melsiddieg/cellbaseR documentation built on Jan. 16, 2024, 4:12 a.m.