CellBaseR: CellBaseR

In melsiddieg/cellbaseR: Querying annotation data from the high performance Cellbase web

CellBaseR

Description

This is a constructor function for the CellBaseR object

Usage

CellBaseR(
  host = "https://ws.zettagenomics.com/cellbase/webservices/rest/",
  version = "v5",
  species = "hsapiens",
  batch_size = 200L,
  num_threads = 8L
)

Arguments

host	A character the default host url for cellbase webservices, e.g. "http://bioinfo.hpc.cam.ac.uk/cellbase/webservices/rest/"
version	A character the cellbae API version, e.g. "V4"
species	a character specifying the species to be queried, e.g. "hsapiens"
batch_size	intger if multiple queries are raised by a single method call, e.g. getting annotation info for several genes, queries will be sent to the server in batches.This slot indicates the size of each batch,e.g. 200
num_threads	integer number of batches to be sent to the server

Details

CellbaseR constructor function

This class defines the CellBaseR object. It holds the default configuration required by CellBaseR methods to connect to the cellbase web services. By defult it is configured to query human data based on the GRCh37 genome assembly.

Value

An object of class CellBaseR

See Also

https://github.com/opencb/cellbase/wiki and the RESTful API documentation http://bioinfo.hpc.cam.ac.uk/cellbase/webservices/

Examples

   cb <- CellBaseR()
   print(cb)

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