Adds a dummy
.R file that will prompt roxygen to generate basic
package-level documentation. If your package is named "foo", this will make
help available to the user via
package?foo. Once you call
devtools::document(), roxygen will flesh out the
.Rd file using data from
DESCRIPTION. That ensures you don't need to repeat the same information
in multiple places. This
.R file is also a good place for roxygen
directives that apply to the whole package (vs. a specific function), such as
global namespace tags like
Open the newly created file for editing? Happens in RStudio, if
applicable, or via
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.