dipr_use_export_doc: Use the template export documentation

View source: R/use.R

dipr_use_export_docR Documentation

Use the template export documentation

Description

This will open and save a markdown file with pre-populated headings and sections to aid in generating output documentation. This is not official documentation but rather a useful guide to meet the standard for the output checkers. This function will automatically output to "out/export" and number sequentially the export folders.

Usage

dipr_use_export_doc(template = "export-doc.md", ...)

Arguments

template

Path to template file relative to templates/ directory within package; see details.

...

further arguments passed to usethis::use_template

Examples

## Not run: 
dipr_use_export_doc()

## End(Not run)

bcgov/dipr documentation built on June 1, 2022, 12:32 p.m.