Exported functions from a package (along with their arguments and any associated default values) are printed to a file.

write_pkg_api(..., filename = "pkg_api")

Arguments

...

Any objects pointing to a package location. This can be a string with a path to a local package directory, or, an invocation of a helper function such as [from_github()].

filename

The output filename for the text to be written to disk.