R/publication-date-element.R

In CVPIA-OSC/EMLaide: Provides functions for building EML metadata for EDI's data repository

#' @title Create Publication Date 
#' @description Creates publication date according to EML standards.
#' @param date The publication date. If left null, it will be assigned the current 
#' date. This can be overridden by putting in a specific date. 
#' @return A publication date object that can be appended to a dataset or project. 
#' @examples 
#' create_pub_date(date = "2020-08-19")
#'              
#' # Creates current date:              
#' create_pub_date() 
#' @export 
create_pub_date <- function(date = NULL) {
  if (is.null(date)) {
    date <- Sys.Date()
  } else {
    date
  }
  return(date)
}

#' Add Publication Date
#' @description Adds the publication date element to a dataset list according to EML standards. 
#' @param parent_element A list representing the EML project or dataset.
#' @param date The publication date. If left null, it will be assigned the current 
#' date. This can be overridden by putting in a specific date: see \code{\link{create_pub_date}} 
#' @return The dataset list or project with publication date information appended.
#' @examples  
#' dataset <- list() %>%
#'     add_pub_date()
#' dataset
#' @export
add_pub_date <- function(parent_element, date = NULL) {
  if (is.null(date)){
    parent_element$pubDate <- create_pub_date()
  }
  else {
    parent_element$pubDate <- create_pub_date(date)
  }
  return(parent_element)
}