RcppParallel.package.skeleton.Rd

% Generatedbyroxygen2:donoteditbyhand
% PleaseeditdocumentationinR/skeleton.R
\name{RcppParallel.package.skeleton}
\alias{RcppParallel.package.skeleton}
\title{CreateaskeletonforanewpackagedependingonRcppParallel}
\usage{
RcppParallel.package.skeleton(name="anRpackage", example_code=TRUE, ...)
}
\arguments{
\item{name}{ThenameofyourRpackage.}

\item{example_code}{If \code{TRUE}, exampleC++codeusingRcppParallelis
addedtothepackage.}

\item{...}{Optionalargumentspassedto \link[Rcpp]{Rcpp.package.skeleton}.}
}
\value{
Nothing, usedforitssideeffects
}
\description{
\code{RcppParallel.package.skeleton} automatesthecreationofanewsource
packagethatintendstousefeaturesofRcppParallel.
}
\details{
Itisbasedonthe \link[utils]{package.skeleton} functionwhichitexecutes
first.

Inadditionto \link[Rcpp]{Rcpp.package.skeleton} :

The \samp{DESCRIPTION} filegainsanImportslinerequestingthatthe
packagedependsonRcppParallelandaLinkingTolinesothatthepackage
findsRcppParallelheaderfiles.

The \samp{NAMESPACE} gainsa \code{useDynLib} directiveaswellasan
\code{importFrom(RcppParallel, evalCpp} toensureinstantiationof
RcppParallel.

The \samp{src} directoryiscreatedifitdoesnotexistsanda
\samp{Makevars} fileisaddedsettingtheenvironmentvariables
\samp{PKG_LIBS} toaccomodatethenecessaryflagstolinkwiththe
RcppParallellibrary.

Ifthe \code{example_code} argumentissetto \code{TRUE}, examplefiles
\samp{vector-sum.cpp} iscreatedinthe \samp{src} directory.
\code{Rcpp::compileAttributes()} isthencalledtogenerate
\code{src/RcppExports.cpp} and \code{R/RcppExports.R}.Thesefilesaregiven
asanexampleandshouldeventuallybyremovedfromthegeneratedpackage.
}
\examples{

\dontrun{
# simple package
RcppParallel.package.skeleton("foobar")
}

}
\references{
Readthe \emph{WritingRExtensions} manualformoredetails.

Onceyouhavecreateda \emph{source} packageyouneedtoinstallit:see
the \emph{RInstallationandAdministration} manual, \code{\link{INSTALL}}
and \code{\link{install.packages}}.
}
\seealso{
\link[utils]{package.skeleton}
}
\keyword{programming}