Namespace

Namespace

Namespaces are important for package development. Namespace enables R to reference the correct package when calling a function external to functions developed inside atlantisom.

Developers of atlantisom must make sure that for all external packages not available in the base distribution of R, that the package is listed in the DESCRIPTION file under Imports followed by a comma.

Please use the following guidelines inside your function code:

• Use @importFrom pkg for packages that are repeatedly used within an atlantisom function (i.e., you utilize many functions from the referenced function and using :: would be obnoxious). The @importFrom should be located near the top of the file in the roxygen documentation.
• Use @importFrom pkg function function if a few functions from a specific package are used many times in an atlantisom function.
• Use pkg::function for functions that are used intermittently inside an atlantisom function. Using :: is slower than the previously mentioned guidelines, but easier for tracing and understanding code.

Guidelines were developed via Hadley Wickam's R package documentation.