submit_page: Submit a Page to the Online Repository

In ropenscilabs/tl: Quick Ref. Guides For R Functions

Submit a Page to the Online Repository

Description

runs checks on the markdown file containing the tl::dr page, and provides instructions to submit the page to the github repository

Usage

submit_page(fun, namespace = NULL, location = getwd())

Arguments

fun	name of function being documented
namespace	the package the function is in
location	the folder containing the package folder and markdown file (see details).

Details

the markdown file should be named <function_name.md>, where <function_name> is the name of the function, and be in a directory with the same name as the package. That package directory should be within the directory given by location (by default the current working directory). the easiest way to set this up is by using create_page().

ropenscilabs/tl documentation built on May 14, 2022, 2:30 a.m.