R/dataset_commit.R

In solvebio/solvebio-r: The Official SolveBio API Client

#' DatasetCommit.all
#'
#' Retrieves the metadata about all dataset commits on SolveBio.
#'
#' @param env (optional) Custom client environment.
#' @param ... (optional) Additional query parameters (e.g. page).
#'
#' @examples \dontrun{
#' DatasetCommit.all()
#' }
#'
#' @references
#' \url{https://docs.solvebio.com/}
#'
#' @export
DatasetCommit.all <- function(env = solvebio:::.solveEnv, ...) {
    .request('GET', "v2/dataset_commits", query=list(...), env=env)
}


#' DatasetCommit.retrieve
#'
#' Retrieves the metadata about a specific dataset commit on SolveBio.
#'
#' @param id String The ID of a SolveBio dataset commit.
#' @param env (optional) Custom client environment.
#'
#' @examples \dontrun{
#' DatasetCommit.retrieve(<ID>)
#' }
#'
#' @references
#' \url{https://docs.solvebio.com/}
#'
#' @export
DatasetCommit.retrieve <- function(id, env = solvebio:::.solveEnv) {
    if (missing(id)) {
        stop("A dataset commit ID is required.")
    }

    path <- paste("v2/dataset_commits", paste(id), sep="/")
    .request('GET', path=path, env=env)
}


#' DatasetCommit.delete
#'
#' Deletes a specific dataset commit on SolveBio.
#'
#' @param id String The ID or full name of a SolveBio dataset commit.
#' @param env (optional) Custom client environment.
#'
#' @examples \dontrun{
#' DatasetCommit.delete(<ID>)
#' }
#'
#' @references
#' \url{https://docs.solvebio.com/}
#'
#' @export
DatasetCommit.delete <- function(id, env = solvebio:::.solveEnv) {
    if (missing(id)) {
        stop("A dataset commit ID is required.")
    }

    path <- paste("v2/dataset_commits", paste(id), sep="/")
    .request('DELETE', path=path, env=env)
}