Plugin Documentation

Goals available for this plugin:

Goal Description
r:build Goal which runs R CMD BUILD.
r:check Goal which runs R CMD check on an already built package. It requires the project to already have packaged with the 'build' goal or by some other means.
r:document Goal which runs devtools::document.
r:help Display help information on r-maven-plugin.
Call mvn r:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
r:sources

Goal that prepares R sources. Standard location for R package sources is inside src/main/R.

This class uses code extracted from Maven Resources Plugin.

Maven Resources Plugin is licensed under the Apache License.

r:validate

Goal that performs some initial checks on the package metadata.

Compliance requires passing tests enumerated in official documentation

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.5.3
JDK 1.7
Memory No minimum requirement.
Disk Space No minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>it.bancaditalia.oss</groupId>
          <artifactId>r-maven-plugin</artifactId>
          <version>1.0.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>it.bancaditalia.oss</groupId>
        <artifactId>r-maven-plugin</artifactId>
        <version>1.0.0</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"