r:sources

Full name:

it.bancaditalia.oss:r-maven-plugin:1.0.0:sources

Description:

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.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: process-sources.

Required Parameters

Name Type Since Description
<outputDirectory> File - The output directory into which to copy the R sources.
Default value is: ${project.build.outputDirectory}.

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.
<delimiters> LinkedHashSet 2.4

Set of delimiters for expressions to filter within the sources. These delimiters are specified in the form beginToken*endToken. If no * is given, the delimiter is assumed to be the same for start and end.

So, the default filtering delimiters might be specified as:

<delimiters>
  <delimiter>${*}</delimiter>
  <delimiter>@</delimiter>
</delimiters>

Since the @ delimiter is the same on both ends, we don't need to specify @*@ (though we can).
<encoding> String - The character encoding scheme to be applied when filtering R sources.
Default value is: ${project.build.sourceEncoding}.
<escapeString> String 2.3 Expressions preceded with this string won't be interpolated. Anything else preceded with this string will be passed through unchanged. For example \${foo} will be replaced with ${foo} but \\${foo} will be replaced with \\value of foo, if this parameter has been set to the backslash.
<escapeWindowsPaths> boolean 2.4 Whether to escape backslashes and colons in windows-style paths.
Default value is: true.
<fileNameFiltering> boolean 3.0.0 Support filtering of filenames folders etc.
Default value is: false.
<filterSources> boolean - Set it to false to disable automatic filtering of R source files.
Default value is: true.
<filters> List - The list of extra filter properties files to be used along with System properties, project properties, and filter properties files specified in the POM build/filters section, which should be used for the filtering during the current mojo execution.
<mavenFilteringHints> List 2.4

List of plexus components hint which implements MavenResourcesFiltering.filterResources(). They will be executed after the sources copying/filtering.
<nonFilteredFileExtensions> List 2.3 Additional file extensions to not apply filtering (already defined are : jpg, jpeg, gif, bmp, png)
<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.
<sharedLibs> File[] - Additional paths where to locate shared libraries needed by R and R packages.
User property is: sharedLibs.
<skip> boolean 3.0.0 You can skip the execution of the plugin if you need to. Its use is NOT RECOMMENDED, but quite convenient on occasion.
Default value is: false.
User property is: R.sources.skip.
<supportMultiLineFiltering> boolean 2.5 stop searching endToken at the end of line
Default value is: false.
<useBuildFilters> boolean 2.4 If false, don't use the filters specified in the build/filters section of the POM when processing sources in this mojo execution.
Default value is: true.
<useDefaultDelimiters> boolean 2.4 Use default delimiters in addition to custom delimiters, if any.
Default value is: true.

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

<delimiters>

Set of delimiters for expressions to filter within the sources. These delimiters are specified in the form beginToken*endToken. If no * is given, the delimiter is assumed to be the same for start and end.

So, the default filtering delimiters might be specified as:

<delimiters>
  <delimiter>${*}</delimiter>
  <delimiter>@</delimiter>
</delimiters>

Since the @ delimiter is the same on both ends, we don't need to specify @*@ (though we can).

  • Type: java.util.LinkedHashSet
  • Since: 2.4
  • Required: No

<encoding>

The character encoding scheme to be applied when filtering R sources.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.sourceEncoding}

<escapeString>

Expressions preceded with this string won't be interpolated. Anything else preceded with this string will be passed through unchanged. For example \${foo} will be replaced with ${foo} but \\${foo} will be replaced with \\value of foo, if this parameter has been set to the backslash.
  • Type: java.lang.String
  • Since: 2.3
  • Required: No

<escapeWindowsPaths>

Whether to escape backslashes and colons in windows-style paths.
  • Type: boolean
  • Since: 2.4
  • Required: No
  • Default: true

<fileNameFiltering>

Support filtering of filenames folders etc.
  • Type: boolean
  • Since: 3.0.0
  • Required: No
  • Default: false

<filterSources>

Set it to false to disable automatic filtering of R source files.
  • Type: boolean
  • Required: No
  • Default: true

<filters>

The list of extra filter properties files to be used along with System properties, project properties, and filter properties files specified in the POM build/filters section, which should be used for the filtering during the current mojo execution.
  • Type: java.util.List
  • Required: No

<mavenFilteringHints>

List of plexus components hint which implements MavenResourcesFiltering.filterResources(). They will be executed after the sources copying/filtering.

  • Type: java.util.List
  • Since: 2.4
  • Required: No

<nonFilteredFileExtensions>

Additional file extensions to not apply filtering (already defined are : jpg, jpeg, gif, bmp, png)
  • Type: java.util.List
  • Since: 2.3
  • Required: No

<outputDirectory>

The output directory into which to copy the R sources.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.outputDirectory}

<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}

<sharedLibs>

Additional paths where to locate shared libraries needed by R and R packages.
  • Type: java.io.File[]
  • Required: No
  • User Property: sharedLibs

<skip>

You can skip the execution of the plugin if you need to. Its use is NOT RECOMMENDED, but quite convenient on occasion.
  • Type: boolean
  • Since: 3.0.0
  • Required: No
  • User Property: R.sources.skip
  • Default: false

<supportMultiLineFiltering>

stop searching endToken at the end of line
  • Type: boolean
  • Since: 2.5
  • Required: No
  • Default: false

<useBuildFilters>

If false, don't use the filters specified in the build/filters section of the POM when processing sources in this mojo execution.
  • Type: boolean
  • Since: 2.4
  • Required: No
  • Default: true

<useDefaultDelimiters>

Use default delimiters in addition to custom delimiters, if any.
  • Type: boolean
  • Since: 2.4
  • Required: No
  • Default: true