R/createProtocol.R

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

#' Create a Protocol on Labstep
#'
#' This function allows you to create a protocol.
#' @name createProtocol
#' @param user A labstep user object. Must contain an `api_key` field. Returned from `login` command
#' @param name The name you want to give your protocol.
#' @return Returns an `protocol` object
#' @import httr
#' @export
#' @examples
#' user <- login("demo@labstep.com","demopassword")
#' protocol <- createProtocol(user,'My First Protocol')
#' print(protocol)

createProtocol <- function(user,name){

  req <- httr::POST('https://api.labstep.com/api/generic/protocol-collection',
              body=list(name=name),
              add_headers(apikey=user$api_key),
              encode='json')

  return(content(req))
}