Read R documentation files from a package's source, convert and write them to disk.
write_the_docs(package_directory, file_name = package_directory,
output_directory = tempdir(), dependencies = NULL, sanitize_Rd = TRUE,
runit = FALSE)
The directory containing the package's source.
The name of the file where to write the documentation into. See Details.
The directory to put the documentation into. You
might want to use dirname(file_name)
.
A character vector of package names the functions depend on.
Remove strange characters from Rdconv
?
Convert the text received from the help files if running RUnit? Do not bother, this is for Unit testing only.
A list containing
The path to the pdf file produced.
The path to the text file produced.
The path to the html file produced.
file_name
will usually be provided by document
as the
R code file's name. This may, differing from a (temporary) package's name,
contain underscores. If you use the functions directly: stick with the
default, in which case internally
the basename
of your package_directory
will be
used. This should be a good guess.