fake_package: Fake a Package From a Single Code File

In document: Run 'roxygen2' on (Chunks of) Single Code Files

Fake a Package From a Single Code File

Description

To build documentation for a single code file, we need a temporary package. Of course the code file should contain roxygen2 comments.

Usage

fake_package(file_name, working_directory = NULL, dependencies = NULL, ...)

Arguments

file_name	The name of the R code file to be documented.
working_directory	A working directory. Keep the default.
dependencies	A character vector of package names the functions depend on.
...	Arguments passed to get_lines_between_tags.

Value

A string containing the path to the faked package.

document documentation built on July 9, 2023, 5:22 p.m.