doc_data: Document Datasets

In jimbrig/lossdevtapp: Actuarial Loss Development

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

data("loss_data")

string <- doc_data(losses, "Loss Data", "Claims Data", FALSE)

cat(string)

jimbrig/lossdevtapp documentation built on Aug. 31, 2024, 8:38 a.m.