R/publisher.R

In dataset: Create Data Frames that are Easier to Exchange and Reuse

#' @title Get/set the Publisher of the object.
#' @description Add the optional \code{Publisher} property as an attribute to an
#'   R object.
#' @details The \code{Publisher} corresponds to dct:publisher and Publisher in
#'   DataCite. The name of the entity that holds, archives, publishes prints,
#'   distributes, releases, issues, or produces the resource. This property will
#'   be used to formulate the citation, so consider the prominence of the role.
#'   For software, use Publisher for the code repository. If there is an entity
#'   other than a code repository, that "holds, archives, publishes, prints,
#'   distributes, releases, issues, or produces" the code, use the property
#'   Contributor/contributorType/ hostingInstitution for the code repository.
#' @param x A dataset object created with \code{dataset::\link{dataset_df}} or
#'   \code{dataset::\link{as_dataset_df}}.
#' @param overwrite If the attributes should be overwritten. In case it is set
#'   to \code{FALSE},it gives a warning with the current \code{publisher}
#'   property instead of overwriting it. Defaults to \code{FALSE}.
#' @param value The \code{Publisher} as a character set.
#' @return The Publisher attribute as a character of length 1 is added to
#'   \code{x}.
#' @examples
#' publisher(orange_df) <- "Wiley"
#' publisher(orange_df)
#' @family Reference metadata functions
#' @importFrom assertthat assert_that
#' @export

publisher <- function(x) {
  assert_that(is.dataset_df(x),
    msg = "publisher(x): x must be a dataset object created with dataset() or as_dataset()."
  )

  DataBibentry <- get_bibentry(x)
  as.character(DataBibentry$publisher)
}

#' @rdname publisher
#' @export
`publisher<-` <- function(x, overwrite = TRUE, value) {
  if (!is.dataset_df(x)) {
    stop("publisher(x): x must be a dataset object created with dataset() or as_dataset().")
  }

  DataBibentry <- invisible(get_bibentry(x))

  if (is.null(value)) {
    DataBibentry$publisher <- ":tba"
    attr(x, "dataset_bibentry") <- DataBibentry
    return(x)
  }

  if (length(value) > 1) {
    stop("publisher(x) <- value: value must be of length 1.")
  }

  is_tba <- DataBibentry$publisher == ":tba"

  if (is.null(DataBibentry$publisher)) {
    DataBibentry$publisher <- value
  } else if (is_tba) {
    DataBibentry$publisher <- value
  } else if (overwrite) {
    DataBibentry$publisher <- value
  } else {
    message("The dataset has already an Publisher: ", DataBibentry$publisher)
  }

  attr(x, "dataset_bibentry") <- DataBibentry
  invisible(x)
}