create_html_help: Creates html help

Description Usage Arguments Examples

View source: R/help.R

Description

It uses the YAML spec file to create a single help entry. Its output is a text vector, with 'HTML' content.

Usage

1
create_html_help(spec_path, package = NULL)

Arguments

spec_path

The file location of the YAML spec translation file. It is a required argument, cannot be left empty.

package

Name of the package as a character variable. It is used in the help tracker.

Examples

1
2
3
library(datalang)
my_spec <- system.file("specs/thisweek.yml", package = "datalang")
create_html_help(my_spec)

edgararuiz/datalang documentation built on May 29, 2019, 11:42 a.m.