man.fetchOpenCGA.Rd Maven / Gradle / Ivy

Go to download
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/commons.R
\name{fetchOpenCGA}
\alias{fetchOpenCGA}
\title{OpencgaR Common functions}
\usage{
fetchOpenCGA(
  object = object,
  category = NULL,
  categoryId = NULL,
  subcategory = NULL,
  subcategoryId = NULL,
  action = NULL,
  params = NULL,
  httpMethod = "GET",
  skip = 0,
  num_threads = NULL,
  as.queryParam = NULL,
  batch_size = 1000
)
}
\description{
This is an S4 class which defines the OpencgaR object
}
\details{
This S4 class holds the default configuration required by OpencgaR 
methods to stablish the connection with the web services. By default it is 
configured to query HGVA (http://hgva.opencb.org/).
}
\section{Slots}{

\describe{
\item{\code{host}}{a character specifying the host url. Default 
"http://bioinfo.hpc.cam.ac.uk/hgva"}

\item{\code{version}}{a character specifying the API version. Default "v1"}
}}

\seealso{
\url{https://github.com/opencb/opencga/wiki} 
and the RESTful API documentation 
\url{http://bioinfo.hpc.cam.ac.uk/opencga/webservices/}
}