R/getExperiment.R

In Labstep/labstepR: An R Package for Working with the Labstep API

#' Retrieve metadata for a particular Labstep Experiment
#'
#' This function allows you to retrieve metadata for a single experiment
#' @name getExperiment
#' @param user A labstep user object. Must contain an `api_key` field. Returned from `login` command
#' @param id ID of the experiment to retrieve
#' @return Returns an `experiment` object
#' @import httr
#' @export
#' @examples
#' user <- login("demo@labstep.com","demopassword")
#' experiment <- getExperiment(user,14671)
#' print(experiment)

getExperiment <- function(user,id){

  url = paste('https://api.labstep.com/api/generic/experiment-workflow/',id,
              sep='')
  req <- httr::GET(url,
             add_headers(apikey=user$api_key),
             encode='json')

  resp = content(req)

  return(resp)
}