R/new_object.R

In rDataPipeline: Functions to Interact with the 'FAIR Data Pipeline'

#' Post entry to object table
#'
#' Upload information to the \code{object} table in the data registry
#'
#' @param description (optional) a \code{string} containing a free text
#' description of the \code{object}
#' @param storage_location_url (optional) a \code{string} specifying the URL
#' of an entry in the \code{storage_location} table
#' @param authors_url (optional) a \code{list} of \code{author} URLs
#' associated with this \code{object}
#' @param file_type_url (optional) a \code{string} specifying the URL
#' of an entry in the \code{file_type} table
#' @param endpoint a \code{string} specifying the registry endpoint
#'
#' @family new functions
#'
new_object <- function(description,
                       storage_location_url,
                       authors_url,
                       file_type_url,
                       endpoint = "http://localhost:8000/api/") {

  data <- list()

  if (!missing(description))
    data$description <- description

  if (!missing(storage_location_url))
    data$storage_location <- storage_location_url

  if (!missing(authors_url))
    data$authors <- authors_url

  if (!missing(file_type_url))
    data$file_type <- file_type_url

  post_data(table = "object",
            data = data,
            endpoint = endpoint)
}