R.Project-methods.R Maven / Gradle / Ivy

Go to download

# WARNING: AUTOGENERATED CODE
#
#    This code was generated by a tool.
#    
#    Manual changes to this file may cause unexpected behavior in your application.
#    Manual changes to this file will be overwritten if the code is regenerated.


# ##############################################################################
#' ProjectClient methods
#' @include AllClasses.R
#' @include AllGenerics.R
#' @include commons.R

#' @description This function implements the OpenCGA calls for managing Projects.

#' The following table summarises the available *actions* for this client:
#'
#' | endpointName | Endpoint WS | parameters accepted |
#' | -- | :-- | --: |
#' | create | /{apiVersion}/projects/create | include, exclude, includeResult, body[*] |
#' | search | /{apiVersion}/projects/search | include, exclude, limit, skip, organization, id, name, fqn, organization, description, study, creationDate, modificationDate, internalStatus, attributes |
#' | info | /{apiVersion}/projects/{projects}/info | include, exclude, projects[*] |
#' | incRelease | /{apiVersion}/projects/{project}/incRelease | project[*] |
#' | studies | /{apiVersion}/projects/{project}/studies | include, exclude, limit, skip, project[*] |
#' | update | /{apiVersion}/projects/{project}/update | include, exclude, project[*], includeResult, body[*] |
#'
#' @md
#' @seealso \url{http://docs.opencb.org/display/opencga/Using+OpenCGA} and the RESTful API documentation
#' \url{http://bioinfo.hpc.cam.ac.uk/opencga-prod/webservices/}
#' [*]: Required parameter
#' @export

setMethod("projectClient", "OpencgaR", function(OpencgaR, project, projects, endpointName, params=NULL, ...) {
    switch(endpointName,

        #' @section Endpoint /{apiVersion}/projects/create:
        #' Create a new project.
        #' @param include Fields included in the response, whole JSON path must be provided.
        #' @param exclude Fields excluded in the response, whole JSON path must be provided.
        #' @param includeResult Flag indicating to include the created or updated document result in the response.
        #' @param data JSON containing the mandatory parameters.
        create=fetchOpenCGA(object=OpencgaR, category="projects", categoryId=NULL, subcategory=NULL,
                subcategoryId=NULL, action="create", params=params, httpMethod="POST", as.queryParam=NULL, ...),

        #' @section Endpoint /{apiVersion}/projects/search:
        #' Search projects.
        #' @param include Fields included in the response, whole JSON path must be provided.
        #' @param exclude Fields excluded in the response, whole JSON path must be provided.
        #' @param limit Number of results to be returned.
        #' @param skip Number of results to skip.
        #' @param organization Project organization.
        #' @param id Project [organization@]project where project can be either the ID or the alias.
        #' @param name Project name.
        #' @param fqn Project fqn.
        #' @param description Project description.
        #' @param study Study id.
        #' @param creationDate Creation date. Format: yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
        #' @param modificationDate Modification date. Format: yyyyMMddHHmmss. Examples: >2018, 2017-2018, <201805.
        #' @param internalStatus Filter by internal status.
        #' @param attributes Attributes.
        search=fetchOpenCGA(object=OpencgaR, category="projects", categoryId=NULL, subcategory=NULL,
                subcategoryId=NULL, action="search", params=params, httpMethod="GET", as.queryParam=NULL, ...),

        #' @section Endpoint /{apiVersion}/projects/{projects}/info:
        #' Fetch project information.
        #' @param include Fields included in the response, whole JSON path must be provided.
        #' @param exclude Fields excluded in the response, whole JSON path must be provided.
        #' @param projects Comma separated list of projects [organization@]project up to a maximum of 100.
        info=fetchOpenCGA(object=OpencgaR, category="projects", categoryId=projects, subcategory=NULL,
                subcategoryId=NULL, action="info", params=params, httpMethod="GET", as.queryParam=NULL, ...),

        #' @section Endpoint /{apiVersion}/projects/{project}/incRelease:
        #' Increment current release number in the project.
        #' @param project Project [organization@]project where project can be either the ID or the alias.
        incRelease=fetchOpenCGA(object=OpencgaR, category="projects", categoryId=project, subcategory=NULL,
                subcategoryId=NULL, action="incRelease", params=params, httpMethod="POST", as.queryParam=NULL, ...),

        #' @section Endpoint /{apiVersion}/projects/{project}/studies:
        #' Fetch all the studies contained in the project.
        #' @param include Fields included in the response, whole JSON path must be provided.
        #' @param exclude Fields excluded in the response, whole JSON path must be provided.
        #' @param limit Number of results to be returned.
        #' @param skip Number of results to skip.
        #' @param project Project [organization@]project where project can be either the ID or the alias.
        studies=fetchOpenCGA(object=OpencgaR, category="projects", categoryId=project, subcategory=NULL,
                subcategoryId=NULL, action="studies", params=params, httpMethod="GET", as.queryParam=NULL, ...),

        #' @section Endpoint /{apiVersion}/projects/{project}/update:
        #' Update some project attributes.
        #' @param include Fields included in the response, whole JSON path must be provided.
        #' @param exclude Fields excluded in the response, whole JSON path must be provided.
        #' @param project Project [organization@]project where project can be either the ID or the alias.
        #' @param includeResult Flag indicating to include the created or updated document result in the response.
        #' @param data JSON containing the params to be updated. It will be only possible to update organism fields not previously defined.
        update=fetchOpenCGA(object=OpencgaR, category="projects", categoryId=project, subcategory=NULL,
                subcategoryId=NULL, action="update", params=params, httpMethod="POST", as.queryParam=NULL, ...),
    )
})