roxy2HTML: roxy2HTML

Description Usage Arguments Details Value Examples

View source: R/roxy2HTML.R

Description

Convert roxygen2 tags directly to html

Usage

1
roxy2HTML(input, output, env = NULL, ...)

Arguments

input,

character, path to R file with roxygen2 tags

output,

character, path to output file to save HTML files

env,

environment, environment to run parse_file. Defaults to NULL

...,

additional parameters to be passed to Rd2HTML

Details

Takes, as input, an R script with roxygen2 tags and outputs the HTML file to an output folder

Value

This function doesn't return anything

Examples

1
2
input_path <- system.file("examples/script.R", package = "directRoxy")
roxy2HTML(input_path, tempdir())

mimikwang/directRoxy documentation built on Dec. 29, 2019, 11:58 a.m.