Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
111 lines (74 sloc) 4.66 KB
---
title: "NAMESPACE tags"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{NAMESPACE tags}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---
```{r, include = FALSE}
knitr::opts_chunk$set(comment = "#>", collapse = TRUE)
```
The package `NAMESPACE` is one of the most confusing parts of building a package. Roxygen2 aims to make it as easy as possible to build a package that is a well-behaved member of the R ecosystem. This is a little frustrating at first, but soon becomes second-nature.
## Exports
For a function to be usable outside of your package, you must __export__ it. By default roxygen2 doesn't export anything from your package. If you want an object to be publicly available, you must explicitly tag it with `@export`.
Use the following guidelines to decide what to export:
* Functions: export functions that you want to make available. Exported
functions must be documented, and you must be cautious when changing their
interface.
* Datasets: all datasets are publicly available. They exist outside of the
package namespace and should not be exported.
* S3 classes: if you want others to be able to create instances of the class
`@export` the constructor function.
* S3 generics: the generic is a function so `@export` if you want it to
be usable outside the package
* S3 methods: every S3 method _must_ be exported, even if the generic is not.
Otherwise the S3 method table will not be generated correctly and internal
generics will not find the correct method.
If you are providing a method for a generic defined in another package,
you must also import that generate.
* S4 classes: if you want others to be able to extend your class, `@export` it.
If you want others to create instances of your class, but not extend it,
`@export` the constructor function, but not the class.
```R
# Can extend and create
#' @export
setClass("A")
# Can extend, but constructor not exported
#' @export
B <- setClass("B")
# Can create, but not extend
#' @export C
C <- setClass("C")
# Can create and extend
#' @export D
#' @exportClass D
D <- setClass("D")
```
* S4 generics: `@export` if you want the generic to be publicly usable.
* S4 methods: you only need to `@export` methods for generics that you
did not define.
* RC classes: the same principles apply as for S4 classes. `@export`
will only export the class.
### Specialised exports
Generally, roxygen2 can generate the correct namespace directive when `@export`ing a specific object. However, you may want to override the defaults and exercise greater control. In this case you can use the more specialised tags described below:
* `@export foo` generates `export(foo)`
* `@exportClass foo` generates `exportClasses(foo)`
* `@exportMethod foo` generates `exportMethods(foo)`
* `@exportPattern foo` generates `exportPattern(foo)`
For even more specialised cases you can use `@rawNamespace code` which inserts `code` literally into the `NAMESPACE`. If you need to automate this, `@evalNamespace foo()` will evaluate the `foo()` in the package environment and insert the results into `NAMESPACE`.
## Imports
The `NAMESPACE` also controls which functions from other packages are made available to your package. Only unique directives are saved to the `NAMESPACE` file, so you can repeat them as needed to maintain a close link between the functions where they are needed and the namespace file.
If you are using just a few functions from another package, the recommended option is to note the package name in the `Imports:` field of the `DESCRIPTION` file and call the function(s) explicitly using `::`, e.g., `pkg::fun()`. Alternatively, though no longer recommended due to its poorer readability, use `@importFrom`, e.g., `@importFrom pgk fun`, and call the function(s) without `::`.
If you are using many functions from another package, use `@import package` to import them all and make available without using `::`.
If you want to add a new method to an S3 generic, import it with `@importFrom pkg generic`.
If you are using S4 you may also need:
* `@importClassesFrom package classa classb ...` to import selected S4 classes.
* `@importMethodsFrom package methoda methodb ...` to import selected S4
methods.
To import compiled code from another package, use `@useDynLib`
* `@useDynLib package` imports all compiled functions.
* `@useDynLib package routinea routineb` imports selected compiled functions.
* Any `@useDynLib` specification containing a comma, e.g.
`@useDynLib mypackage, .registration = TRUE` will be inserted as is
into the the NAMESPACE, e.g. `useDynLib(mypackage, .registration = TRUE)`
You can’t perform that action at this time.