platformInfo: platformInfo

In oganm/gemmaAPI: A wrapper for Gemma's restful API

platformInfo

Description

Retrieves information about a single platform. Combines several API calls.

Usage

platformInfo(
  platform,
  request = NULL,
  ...,
  file = NULL,
  return = TRUE,
  overwrite = FALSE,
  memoised = FALSE
)

Arguments

platform	Can either be the platform ID or its short name (e.g: GPL1355). Retrieval by ID is more efficient. Only platforms that user has access to will be available. If a vector of length>1 is provided return all matching platform objects similar to allPlatforms but without access to additional parameters. request parameter cannot be specified for vector inputs
request	Character. If NULL retrieves the platform object. Otherwise datasets: Retrieves experiments in the given platform. Parameters: offset: Optional, defaults to 0. Skips the specified amount of objects when retrieving them from the database. limit: Optional, defaults to 20. Limits the result to specified amount of objects. Use 0 for no limit. annotations: Retrieves the annotation file for the given platform. If you set a file path, the downloaded file will be a .gz file. elements: Retrieves the composite sequences (elements/probes) for the given platform. Parameters: offset: As in datasets limit: As in datasets specificElement Retrieves a specific composite sequence (element) for the given platform. Paramaters: probe: Required. Can either be the probe name or ID. genes Retrieves the genes on the given platform element. Parameters: probe: Required. Can either be the probe name or ID. offset: As in datasets limit: As in datasets
...	Use if the specified request has additional parameters.
file	Character. File path. If provided, response will be saved to file
return	Logical. If the response should be returned. Set to false when you only want to save a file
overwrite	Logical. If TRUE, existing files will be overwritten. If FALSE a warning will be thrown and no action is taken.
memoised	Logical. If TRUE a memoised version of the function will be used which is faster for repeated requests. Use forgetGemmaMemoised to clear memory.

Value

A data.frame or a list depending on the request

Examples

platformInfo('GPL1355')
platformInfo('GPL1355',request = 'datasets',limit = 10)

oganm/gemmaAPI documentation built on July 23, 2022, 8:26 p.m.