R/meta_depth.R

In Ingenuity-Inc/artlookR: Work with artlook data

#' artlookR instructional_depth metadata
#'
#' There is only one set of values for \code{instructional_depth} used across the entire artlookR platform (i.e., this table is listed in the
#' \code{public} schema). #' Because of that there is no requirement in this function to identify a \code{comm_name}.
#' @return A list with the label names and corresponding levels of \code{instructional_depth} values.
#' @details * This function changes the label for missing depth data from the artlookR default of "" to "Depth Unavailable".
#'
#' * Because this information is not stored in the artlookR database, you are not required to run the \code{connection.R} script
#' and create a connection object for this script to run.
#' @examples meta_depth()
#' @export
meta_depth <- function(...){

  list(label = c("Beginning", "Intermediate", "Advanced", "Depth Unavailable"),
       level = c("beginning", "intermediate", "advanced", ""))

}