Skip to content

Commit

Permalink
Update cran-comments; add JW's ORCID; change \href to \doi in surveyCV.r
Browse files Browse the repository at this point in the history
  • Loading branch information
civilstat committed Mar 15, 2022
1 parent e0effb1 commit 68c3541
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 38 deletions.
3 changes: 2 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Date: 2022-03-14
Authors@R: c(
person("Cole", "Guerin", email = "cole@guerincreative.com", role = "aut"),
person("Thomas", "McMahon", email = "thomasmcmahon9@gmail.com", role = "aut"),
person("Jerzy", "Wieczorek", email = "jawieczo@colby.edu", role = c("cre", "aut")),
person("Jerzy", "Wieczorek", email = "jawieczo@colby.edu", role = c("cre", "aut"),
comment = c(ORCID = "0000-0002-2859-6534")),
person("Hunter", "Ratliff", role = "ctb"))
Description: Functions to generate K-fold cross validation (CV) folds
and CV test error estimates that take into account
Expand Down
2 changes: 1 addition & 1 deletion R/surveyCV.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
#' which model best fits the data using K-fold cross validation.
#' Our paper on "K-Fold Cross-Validation for Complex Sample Surveys"
#' by Wieczorek, Guerin, and McMahon (2022)
#' \href{https://doi.org/10.1002/sta4.454}{<doi:10.1002/sta4.454>}
#' <\doi{10.1002/sta4.454}>
#' explains why differing how we take folds based on survey design is useful.
#'
#' The code for this package seeks to create an alternative for the
Expand Down
43 changes: 8 additions & 35 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,15 @@
## Resubmission
## Summary of changes since last CRAN version (v0.1.1)

This is a resubmission. In this version I have:

* Used only undirected quotation marks in the DESCRIPTION text.

* Added \value to .Rd files to describe function results and output structure,
as well as \seealso and other links to related documentation,
for each of man/cv.svy.Rd, man/cv.svydesign.Rd, and man/cv.svyglm.Rd.

* Replaced print() information messages to the console with stopifnot(),
in R/cv.svy.R.

* Removed R/plot_generation.R and vignettes/early-results.Rmd,
in which we used to set a random seed inside a function.
Also removed the associated saved simulated data from R/sysdata.rda,
and removed 'sampling' package from Suggests.
We had been using them internally to document earlier work in progress,
but this function and vignette are not needed by package users.

* Changed Depends to earlier R 4.0 (as well as Suggests for grid and splines).
* Update docs with link to *Stat* paper <doi:10.1002/sta4.454> published on Jan 12, 2022.
* Allow logistic regression response variable to be a factor, not just 0/1. Add logistic regression `example()` to function documentation.
* Add `na.rm` arguments, passed internally to `svymean` when calculating average of CV test losses.
* Make `folds.svy()` and `folds.svydesign()` functions directly accessible and documented, so that users can form survey-design-based CV folds and use them with other models besides `svyglm`.
* Add examples to README and `intro` vignette illustrating how to use `folds.svy()` with design-consistent random forest models from the `rpms` package.


## Test environments

* local Windows 10 install, R 4.1.2
* local Windows 10 install, R 4.1.3
* devtools::check_rhub()
* devtools::check_win_release()
* devtools::check_win_devel()
Expand All @@ -32,20 +18,7 @@ but this function and vignette are not needed by package users.

## R CMD check results

There were no ERRORs or WARNINGs.

There were two NOTEs:

* New submission

This is indeed a new submission.

* Possibly misspelled words in DESCRIPTION:
GitHub (17:62)
SRS (12:6)
repo (17:69)

Those words are not misspelled. SRS = simple random sample.
There were no ERRORs, WARNINGs, or NOTEs.


## Downstream dependencies
Expand Down
2 changes: 1 addition & 1 deletion man/surveyCV.Rd

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

0 comments on commit 68c3541

Please sign in to comment.