File: init_cpp.Rd

package info (click to toggle)
r-cran-rstantools 2.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 624 kB
  • sloc: sh: 15; cpp: 5; makefile: 2
file content (27 lines) | stat: -rw-r--r-- 972 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/init_cpp.R
\name{init_cpp}
\alias{init_cpp}
\title{Register functions implemented in C++}
\usage{
init_cpp(name, path)
}
\arguments{
\item{name}{The name of your package as a string.}

\item{path}{The path to the root directory for your package as a string. If
not specified it is assumed that this is already the current working
directory.}
}
\value{
This function is only called for its side effect of writing the
necessary \code{init.cpp} file to the package's \verb{src/} directory.
}
\description{
If you set up your package using \code{rstan_package_skeleton()} before
version \verb{1.2.1} of \pkg{rstantools} it may be necessary for you to call
this function yourself in order to pass \verb{R CMD check} in \R
\verb{>= 3.4}. If you used \code{rstan_package_skeleton()} in \pkg{rstantools} version
\verb{1.2.1} or later then this has already been done automatically.
}
\keyword{internal}