namespace_roclet: Roclet: make 'NAMESPACE'

Description Usage See Also Examples

View source: R/namespace.R

Description

This roclet automates the production of a NAMESPACE file, which controls the functions imported and exported by your package, as described in Writing R extensions.

The NAMESPACE is generated in two passes: the first generates only import directives (because this can be computed without evaluating package code), and the second generates everything (after the package has been loaded).

See vignette("namespace") for details.

Usage

1

See Also

Other roclets: rd_roclet(), vignette_roclet()

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# The most common namespace tag is @export, which declares that a function
# is part of the external interface of your package
#' @export
foofy <- function(x, y, z) {
}

# You'll also often find global imports living in a file called
# R/{package}-package.R.
#' @importFrom magrittr %>%
#' @import rlang
NULL

roxygen2 documentation built on Sept. 8, 2021, 9:08 a.m.