save_rd: Creates and saved R help file

Description Usage Arguments Examples

View source: R/rd.R

Description

Saves a the help output, from 'create_rd()', into an 'rd' file with the same name as the translated dataset.

This function is meant for packages that will ship with a copy of the translated data set.

Usage

1
save_rd(spec_path = NULL, rd_folder = "man")

Arguments

spec_path

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

rd_folder

The target folder location where the 'rd' file will be save to. Defaults to 'man'.

Examples

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

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