Prepare for resubmission (v3)

vgherard · Feb 11, 2021 · 3760408 · 3760408
1 parent a370984
commit 3760408
Show file tree

Hide file tree

Showing 10 changed files with 43 additions and 19 deletions.
diff --git a/R/perplexity.R b/R/perplexity.R
@@ -56,7 +56,7 @@
 #' # compute their perplexities on the training and test corpora.
 #' # We use Shakespeare's "A Midsummer Night's Dream" as test.
 #' 
-#' \dontrun{
+#' \donttest{
 #' train <- much_ado
 #' test <- midsummer
 #' 

diff --git a/R/sample_sentences.R b/R/sample_sentences.R
@@ -38,7 +38,7 @@
 #' # Sample sentences from 8-gram Kneser-Ney model trained on Shakespeare's
 #' # "Much Ado About Nothing"
 #' 
-#' \dontrun{
+#' \donttest{
 #' 
 #' ### Prepare the model and set seed
 #' freqs <- kgram_freqs(much_ado, 8, .tknz_sent = tknz_sent)

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,3 +1,18 @@
+## Resubmission (v3)
+
+This resubmission addresses two issues pointed out in previous submission:
+
+1. Unnecessary use of dontrun{} in examples.
+2. Always make sure to reset to user's options().
+
+My response:
+
+1. There are four examples marked with `\dontrun{}`, in `?sample_sentences`, `?perplexity` and `?kgram_freqs`. The examples in `?sample_sentences` and `?perplexity` require >5s on some machines, thus I have replaced `\dontrun{}` with `\donttest{}`. The two examples marked with `\dontrun{}` in `kgram_freqs` require (i) a mock file which does not exist and (ii) internet connection. Following the CRAN guide to Writing R Extensions, I left the `\dontrun{}` directive for these examples:
+
+«Thus, example code not included in \dontrun must be executable! In addition, it should not use any system-specific features or require special facilities (such as Internet access or write permission to specific directories).»
+
+2. In the vignette (c.f. inst/doc/kgrams.R) I was setting plot margins with `par()` without resetting them to the original user's value. Fixed this.
+
 ## Resubmission (v2)
 
 Changes from previous version:

diff --git a/docs/articles/kgrams.html b/docs/articles/kgrams.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -3,7 +3,7 @@ pkgdown: 1.6.1
 pkgdown_sha: ~
 articles:
  kgrams: kgrams.html
-last_built: 2021-02-07T21:32Z
+last_built: 2021-02-11T11:06Z
 urls:
  reference: https://vgherard.github.io/kgrams//reference
  article: https://vgherard.github.io/kgrams//articles

diff --git a/docs/reference/perplexity.html b/docs/reference/perplexity.html
diff --git a/docs/reference/sample_sentences.html b/docs/reference/sample_sentences.html
diff --git a/man/perplexity.Rd b/man/perplexity.Rd
diff --git a/man/sample_sentences.Rd b/man/sample_sentences.Rd
diff --git a/vignettes/kgrams.Rmd b/vignettes/kgrams.Rmd
@@ -298,12 +298,13 @@ FUN <- function(D, N) {
  perplexity(midsummer, model = kn)
 }
 P_grid <- lapply(2:5, function(N) sapply(D_grid, FUN, N = N))
-par(mar = c(2, 2, 1, 1))
+oldpar <- par(mar = c(2, 2, 1, 1))
 plot(D_grid, P_grid[[1]], type = "n", xlab = "D", ylab = "Perplexity", ylim = c(300, 500))
 lines(D_grid, P_grid[[1]], col = "red")
 lines(D_grid, P_grid[[2]], col = "chartreuse")
-lines(D_grid, P_grid[[3]], col = "blue",)
-lines(D_grid, P_grid[[4]], col = "black",)
+lines(D_grid, P_grid[[3]], col = "blue")
+lines(D_grid, P_grid[[4]], col = "black")
+par(oldpar)
 ```
 
 We see that the optimal choices for `D` are close to its maximum allowed value