forked from r-lib/usethis
-
Notifications
You must be signed in to change notification settings - Fork 0
/
use_rcpp.Rd
35 lines (32 loc) · 1 KB
/
use_rcpp.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rcpp.R
\name{use_rcpp}
\alias{use_rcpp}
\alias{use_rcpp_armadillo}
\alias{use_rcpp_eigen}
\alias{use_c}
\title{Use C, C++, RcppArmadillo, or RcppEigen}
\usage{
use_rcpp(name = NULL)
use_rcpp_armadillo(name = NULL)
use_rcpp_eigen(name = NULL)
use_c(name = NULL)
}
\arguments{
\item{name}{If supplied, creates and opens \verb{src/name.\{c,cpp\}}.}
}
\description{
Adds infrastructure commonly needed when using compiled code:
\itemize{
\item Creates \verb{src/}
\item Adds required packages to \code{DESCRIPTION}
\item May create an initial placeholder \code{.c} or \code{.cpp} file
\item Creates \code{Makevars} and \code{Makevars.win} files (\code{use_rcpp_armadillo()} only)
}
}
\details{
When using compiled code, please note that there must be at least one file
inside the \verb{src/} directory prior to building the package. As a result,
if an empty \verb{src/} directory is detected, either a \code{.c} or \code{.cpp} file will
be added.
}