R/demo.R

In k-hench/testpkg: Demo of a R package created with {usethis}

#' Silly Warning
#'
#' \code{indicate_concerns} prompts a silly warning to the console
#'
#' This function was included for demo purposes.
#' It is used as a dummy function with some elaborate
#' documentation.
#'
#' @examples
#' indicate_concerns()
#'
#' @export
indicate_concerns <- function(){
  ## give silly warning
  cat("O Dear!")
}

#' Dummy Table
#'
#' \code{demo_table} provides a tiny dummy data set
#'
#' This data set was included for demo purposes.
#'
#' @examples
#' demo_table
#'
#' @export
demo_table <- data.frame(x = 1:3,
                         y = 4:6)