Skip to content

Commit

Permalink
Update news and doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jgabry committed Mar 29, 2017
1 parent 56c7ce4 commit 966078d
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 8 deletions.
6 changes: 6 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# rstantools 1.2.1
(Github issue/PR numbers in parentheses)

* Add `init_cpp` function for generating `src/init.cpp` in order to pass R CMD
check in R 3.4.x. `rstan_package_skeleton` calls `init_cpp` internally. (#6)

# rstantools 1.2.0

(Github issue/PR numbers in parentheses)
Expand Down
9 changes: 5 additions & 4 deletions R/init_cpp.R
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
#' Register functions implemented in C++
#'
#' If you set up your package using \code{\link{rstan_package_skeleton}} before
#' version version 1.2.1 of \pkg{rstantools} it may be necessary for you to call
#' this function yourself. If you used \code{\link{rstan_package_skeleton}} in
#' version 1.2.1 or later then this has already been done automatically.
#' version \code{1.2.1} of \pkg{rstantools} it may be necessary for you to call
#' this function yourself in order to pass \code{R CMD check} in \R \code{>=
#' 3.4}. If you used \code{rstan_package_skeleton} in \pkg{rstantools} version
#' \code{1.2.1} or later then this has already been done automatically.
#'
#' @export
#' @param name The name of your package as a string.
#' @param 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.
#' @return This function is only called for its side effect of writing the
#' necessary "init.cpp" file to the package's \code{src/} directory.
#' necessary \code{init.cpp} file to the package's \code{src/} directory.
#'
init_cpp <- function(name, path) {
file <- file.path("src", "init.cpp")
Expand Down
9 changes: 5 additions & 4 deletions man/init_cpp.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 966078d

Please sign in to comment.