R/data_doc.R

In maelle/eml.tools: Helps Using EML Metadata

#' Example data.frame with fake animals data
#'
#' Example data.frame with fake animals data.
#'
#' A data.frame(\code{dplyr tbl_df}) with
#' \itemize{
#' \item animal. \code{factor}, animal code
#' \item age \code{factor}, age category code
#' \item size \code{numeric}, size of the animal
#' }
#'
#' @format A data.frame(\code{dplyr tbl_df})
#' @name animals_data
#' @docType data
#' @keywords data
#' @usage data(animals_data)
NULL

#' Example eml for the fake animals data
#'
#' Example eml for the fake animals data
#'
#' An \code{eml}
#'
#' @format \code{eml}
#' @name animals_eml
#' @docType data
#' @keywords data
#' @usage data(animals_eml)
NULL

#' Other example eml for the fake animals data
#'
#' Other example eml for the fake animals data
#'
#' An \code{eml} for a dataset, not a single table.
#'
#' @format \code{eml}
#' @name animals_db_eml
#' @docType data
#' @keywords data
#' @usage data(animals_db_eml)
NULL