Rcpp::interfaces attribute is added to a C++ source file to specify which languages to generate bindings for from exported functions. For example:
Interfaces to generate for exported functions within the source file. Valid values are
Rcpp::interfaces attribute is used to determine which bindings to generate for exported functions. The default behavior if no
Rcpp::interfaces attribute is specified is to generate only an R interface.
cpp bindings are requested code is generated as follows:
Bindings are generated into a header file located in the
inst/include directory of the package using the naming convention PackageName_RcppExports.h
If not already present, an additional header file named PackageName.h is also generated which in turn includes the Rcpp exports header.
In the case that you already have a PackageName.h header for your package then you can manually add an include of the Rcpp exports header to it to make the exported functions available to users of your package.
The generated header file allows calling the exported C++ functions without any linking dependency on the package (this is based on using the
The exported functions are defined within a C++ namespace that matches the name of the package.
For example, an exported C++ function
foo could be called from package
MyPackage as follows:
1 2 3 4 5 6 7
The above example assumes that the
sourceCpp function will be used to compile the code. If rather than that you are building a package then you don't need to include the
Rcpp::depends attribute, but instead should add an entry for the referenced package in the
LinkingTo fields of your package's
If a file by the name of PackageName.h that wasn't generated by
compileAttributes already exists in in the
inst/include directory then it will not be overwritten (rather, an error will occur).
A static naming scheme for generated header files and namespaces is used to ensure consistent usage semantics for clients of exported
cpp interfaces. Packages that wish to export more complex interfaces or additional C++ types are therefore typically better off not using this mechanism.
Rcpp::interfaces attribute is specified using a syntax compatible with the new generalized attributes feature of the C++11 standard. Note however that since this feature is not yet broadly supported by compilers it needs to be specified within a comment (see examples below).
1 2 3 4 5
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.