man/cBioPortal-class.Rd
68e6870c
 % Generated by roxygen2: do not edit by hand
150c2f1e
 % Please edit documentation in R/cBioPortal-class.R
68e6870c
 \docType{class}
 \name{cBioPortal-class}
 \alias{cBioPortal-class}
 \alias{.cBioPortal}
150c2f1e
 \alias{operations,cBioPortal-method}
94beb5b3
 \title{A class for representing the cBioPortal API protocol}
150c2f1e
 \usage{
 \S4method{operations}{cBioPortal}(x, ..., .deprecated = FALSE)
 }
 \arguments{
54ed32a7
 \item{x}{A \link[AnVIL:Services]{AnVIL} instance or API representation as
150c2f1e
 given by the \link{cBioPortal} function.}
 
 \item{...}{additional arguments passed to methods or, for
5ad9d32b
 \verb{operations,Service-method}, to the internal \code{get_operation()}
150c2f1e
 function.}
 
 \item{.deprecated}{optional logical(1) include deprecated operations?}
 }
8161d2a9
 \value{
 A \code{cBioPortal} class instance
 }
68e6870c
 \description{
150c2f1e
 The \code{cBioPortal} class is a representation of the \code{cBioPortal}
 API protocol that directly inherits from the \code{Service} class in the
 \code{AnVIL} package. For more information, see the
54ed32a7
 \link[AnVIL:Services]{AnVIL} package.
9c6513ff
 }
 \details{
 This class takes the static API as provided at
0d85dba9
 \url{https://www.cbioportal.org/api/v2/api-docs} and creates an R object
150c2f1e
 with the help from underlying infrastructure (i.e.,
 \link[rapiclient:rapiclient-package]{rapiclient} and
54ed32a7
 \link[AnVIL:Services]{AnVIL}) to give the user a unified representation
150c2f1e
 of the API specification provided by the cBioPortal group. Users are not
 expected to interact with this class other than to use it as input
 to the functionality provided by the rest of the package.
68e6870c
 }
150c2f1e
 \section{Functions}{
 \itemize{
209d3d30
 \item \code{operations(cBioPortal)}: List all the \code{operations} available with the
 cBioPortal API object, e.g., \code{api$operation}
150c2f1e
 
5ad9d32b
 }}
68e6870c
 \examples{
 
94beb5b3
 cBioPortal()
68e6870c
 
 }
 \seealso{
54ed32a7
 \link{cBioPortal}, \link[AnVIL:Services]{AnVIL}
68e6870c
 }