Print('This should really do something useful!') #' environment_info('Hi, what is your name?') #' msg The message that should be printed #' This function prints current environment information, and a message. #' A function to print information about the current environment. Be sure to define the overall purpose of the function, and each of its parameters. This is done in the roxygen2 approach of providing embedded comments in the source code files, which are in turn converted into manual pages and other R documentation artifacts. You should provide documentation for each of your functions and classes. and a list of specifically imported functions from a package: If you need to use all (or most functions from a package), you can import all of its functions: #' ggplot2įor an example to poke around, see the codyn package that came out of the NCEAS community dynamics working group This will ensure that only the necessary functions and packages are downloaded and specific functions are referenced by NAMESPACE. The in the documentation for any package, add the following line: #' ggplot2 ggplot Instead, list a package under Imports like so: Imports: This can lead to a large number of dependencies being installed each time. It’s basically like saying library(other_package) every time your package is loaded. But in brief:Īvoid depends as much as possible. Title: Utility functions created by Matt Jonesĭescription: Package mytools contains a suite of utility functions useful whenever I need stuff to get done.įor discussion on when to list a package under Imports or Depends, see this discussion on StackOverflow. Information about choosing a LICENSE is provided in the Extending R documentation. Edit the DESCRIPTION file to provide reasonable values for each of the fields.

The most important of which is the DESCRIPTION file, which provides metadata about your package.

This will create a top-level directory structure, including a number of critical files under the standard R package structure. Which eliminates pretty much all reasons for procrastination. Thanks to the great devtools package, it only takes one function call to create the skeleton of an R package using create().

Create r package