r:document
Full name:
it.bancaditalia.oss:r-maven-plugin:1.0.0:document
Description:
Goal which runs devtools::document.
Attributes:
- Requires a Maven project to be executed.
- Binds by default to the lifecycle phase: compile.
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| <attachArtifact> | boolean | - | True if the artifact produced by the build should be attached to
the project. Default value is: true. User property is: attachArtifact. |
| <classifier> | String | - | Classifier of produced R artifact. User property is: classifier. |
| <rHome> | File | - | Location of R installation directory. Default value is taken from
R_HOME environment variable. Default value is: ${env.R_HOME}. User property is: rHome. |
| <roclets> | String | - | A comma-separated list of unquoted roclet names to be passed to
ROxygen. |
| <sharedLibs> | File[] | - | Additional paths where to locate shared libraries needed by R and R
packages. User property is: sharedLibs. |
Parameter Details
<attachArtifact>
True if the artifact produced by the build should be attached to
the project.
- Type: boolean
- Required: No
- User Property: attachArtifact
- Default: true
<classifier>
Classifier of produced R artifact.
- Type: java.lang.String
- Required: No
- User Property: classifier
<rHome>
Location of R installation directory. Default value is taken from
R_HOME environment variable.
- Type: java.io.File
- Required: No
- User Property: rHome
- Default: ${env.R_HOME}
<roclets>
A comma-separated list of unquoted roclet names to be passed to
ROxygen.
- Type: java.lang.String
- Required: No
<sharedLibs>
Additional paths where to locate shared libraries needed by R and R
packages.
- Type: java.io.File[]
- Required: No
- User Property: sharedLibs