Document Datasets — doc

Creates skeleton to document datasets via roxygen2.

Usage

doc_data(
  obj,
  title = deparse(substitute(obj)),
  description = "DATASET_DESCRIPTION",
  write_to_file = TRUE,
  ...
)

Arguments

obj: object to document
title: Title
description: Description
write_to_file: Logical
...: N/A

Value

silently returns the doc_string

Examples

library(lossrx)
data(losses)
string <- doc_data(losses, "Loss Data", "Claims Data", FALSE)
cat(string)
#> 
#> #' Loss Data
#> #'
#> #' Claims Data
#> #'
#> #' @format A `data.frame` with 79748 rows and 30 variables:
#> #' \describe{
#> #'   \item{\code{eval_date}}{double. DESCRIPTION.}
#> #'   \item{\code{devt_age}}{double. DESCRIPTION.}
#> #'   \item{\code{occurrence_number}}{character. DESCRIPTION.}
#> #'   \item{\code{coverage}}{character. DESCRIPTION.}
#> #'   \item{\code{member}}{character. DESCRIPTION.}
#> #'   \item{\code{program_year}}{character. DESCRIPTION.}
#> #'   \item{\code{loss_date}}{double. DESCRIPTION.}
#> #'   \item{\code{rept_date}}{double. DESCRIPTION.}
#> #'   \item{\code{hire_date}}{double. DESCRIPTION.}
#> #'   \item{\code{report_lag}}{double. DESCRIPTION.}
#> #'   \item{\code{report_lag_group}}{integer. DESCRIPTION.}
#> #'   \item{\code{day_of_week}}{character. DESCRIPTION.}
#> #'   \item{\code{claim_type}}{character. DESCRIPTION.}
#> #'   \item{\code{claimant_state}}{character. DESCRIPTION.}
#> #'   \item{\code{loss_state}}{character. DESCRIPTION.}
#> #'   \item{\code{cause}}{character. DESCRIPTION.}
#> #'   \item{\code{department}}{character. DESCRIPTION.}
#> #'   \item{\code{tenure}}{double. DESCRIPTION.}
#> #'   \item{\code{tenure_group}}{integer. DESCRIPTION.}
#> #'   \item{\code{claimant_age}}{double. DESCRIPTION.}
#> #'   \item{\code{claimant_age_group}}{integer. DESCRIPTION.}
#> #'   \item{\code{driver_age}}{double. DESCRIPTION.}
#> #'   \item{\code{driver_age_group}}{integer. DESCRIPTION.}
#> #'   \item{\code{status}}{character. DESCRIPTION.}
#> #'   \item{\code{total_paid}}{double. DESCRIPTION.}
#> #'   \item{\code{total_incurred}}{double. DESCRIPTION.}
#> #'   \item{\code{count}}{double. DESCRIPTION.}
#> #'   \item{\code{open_count}}{double. DESCRIPTION.}
#> #'   \item{\code{close_count}}{double. DESCRIPTION.}
#> #'   \item{\code{incurred_group}}{integer. DESCRIPTION.}
#> #' }
#> "Loss Data"