doc_data: Document Datasets

In jimbrig/lossrx: Actuarial Loss Development and Reserving with R

Document Datasets

Description

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)

jimbrig/lossrx documentation built on Dec. 20, 2024, 3:46 a.m.