Skip to content

Commit 5312a25

Browse files
committed
document pkgKitten in NEWS
1 parent 5606dc3 commit 5312a25

File tree

2 files changed

+19
-12
lines changed

2 files changed

+19
-12
lines changed

inst/NEWS.Rd

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@
3737
\itemize{
3838
\item The \code{Rcpp-FAQ} vignette was updated with respect to OS X issues.
3939
}
40+
\item Changes in Rcpp support functions:
41+
\itemize{
42+
\item The \code{Rcpp.package.skeleton()} function will now use
43+
\cpkg{pkgKitten} package, if available, to create a package which passes
44+
\code{R CMD check} without warnings. A new \code{Suggests:} has been added
45+
for \cpkg{pkgKitten}.
46+
}
4047
}
4148
}
4249

inst/unitTests/runit.Rcpp.package.skeleton.R

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ if (.runThisTest) {
9696

9797
}
9898

99-
test.Rcpp.package.skeleton.Attributes <- function(){
99+
test.Rcpp.package.skeleton.Attributes <- function() {
100100

101101
tempdir <- tempdir()
102102
path <- tempdir
@@ -107,15 +107,15 @@ if (.runThisTest) {
107107
Rcpp.package.skeleton("foo", path=path, attributes=TRUE, example_code=TRUE,
108108
environment=environment())
109109
on.exit( unlink(pkg_path, recursive=TRUE) )
110-
checkTrue( file.exists( file.path(src_path, "RcppExports.cpp") ),
110+
checkTrue(file.exists( file.path(src_path, "RcppExports.cpp")),
111111
"RcppExports.cpp was created")
112-
checkTrue( file.exists( file.path(src_path, "rcpp_hello_world.cpp") ),
112+
checkTrue(file.exists( file.path(src_path, "rcpp_hello_world.cpp")),
113113
"rcpp_hello_world.cpp was created" )
114-
checkTrue( file.exists( file.path(R_path, "RcppExports.R") ),
114+
checkTrue(file.exists( file.path(R_path, "RcppExports.R")),
115115
"RcppExports.R was created")
116116
}
117117

118-
test.Rcpp.package.skeleton.NoAttributes <- function(){
118+
test.Rcpp.package.skeleton.NoAttributes <- function() {
119119

120120
tempdir <- tempdir()
121121
path <- tempdir
@@ -126,15 +126,15 @@ if (.runThisTest) {
126126
Rcpp.package.skeleton("foo", path=path, attributes=FALSE, example_code=TRUE,
127127
environment=environment())
128128
on.exit( unlink(pkg_path, recursive=TRUE) )
129-
checkTrue( file.exists( file.path(src_path, "rcpp_hello_world.cpp") ),
129+
checkTrue(file.exists( file.path(src_path, "rcpp_hello_world.cpp")),
130130
"rcpp_hello_world.cpp was created")
131-
checkTrue( file.exists( file.path(src_path, "rcpp_hello_world.h") ),
131+
checkTrue(file.exists( file.path(src_path, "rcpp_hello_world.h")),
132132
"rcpp_hello_world.h was created")
133-
checkTrue( file.exists( file.path(R_path, "rcpp_hello_world.R") ),
133+
checkTrue(file.exists( file.path(R_path, "rcpp_hello_world.R")),
134134
"rcpp_hello_world.R was created" )
135135
}
136136

137-
test.Rcpp.package.skeleton.Module <- function(){
137+
test.Rcpp.package.skeleton.Module <- function() {
138138

139139
tempdir <- tempdir()
140140
path <- tempdir
@@ -143,9 +143,9 @@ if (.runThisTest) {
143143
src_path <- file.path(pkg_path, "src")
144144

145145
Rcpp.package.skeleton("foo", path=path, module=TRUE, environment=environment())
146-
on.exit( unlink(pkg_path, recursive=TRUE) )
147-
checkTrue( file.exists( file.path(src_path, "rcpp_module.cpp") ),
148-
"rcpp_module.cpp was created" )
146+
on.exit(unlink(pkg_path, recursive=TRUE))
147+
checkTrue(file.exists( file.path(src_path, "rcpp_module.cpp")),
148+
"rcpp_module.cpp was created")
149149
}
150150

151151
}

0 commit comments

Comments
 (0)