From a5560a820d5741dc70b602a706a9bd9cb46a1df9 Mon Sep 17 00:00:00 2001 From: "Daniel J. McDonald" Date: Sun, 27 Aug 2023 10:43:09 -0700 Subject: [PATCH] update readme --- R/bccovid.R | 4 ++++ R/nytimes.R | 2 ++ R/test_latex_installation.R | 4 ---- README.Rmd | 6 ++++-- README.md | 10 ++++++---- 5 files changed, 16 insertions(+), 10 deletions(-) diff --git a/R/bccovid.R b/R/bccovid.R index b5ac6b7..fe2d358 100644 --- a/R/bccovid.R +++ b/R/bccovid.R @@ -31,6 +31,7 @@ #' #' @examples #' bccovid +#' "bccovid" #' @details @@ -40,6 +41,7 @@ #' @rdname bccovid #' @examples #' bccovid_train +#' "bccovid_train" @@ -51,6 +53,7 @@ #' @rdname bccovid #' @examples #' bccovid_test +#' "bccovid_test" #' @details @@ -60,4 +63,5 @@ #' @rdname bccovid #' @examples #' bcpop +#' "bcpop" diff --git a/R/nytimes.R b/R/nytimes.R index d1f8161..688eed2 100644 --- a/R/nytimes.R +++ b/R/nytimes.R @@ -56,6 +56,7 @@ NULL #' @rdname nytimes #' @examples #' nyt_raw +#' "nyt_raw" #' @rdname nytimes @@ -67,4 +68,5 @@ NULL #' @keywords datasets #' @examples #' nyt_tfidf +#' "nyt_tfidf" diff --git a/R/test_latex_installation.R b/R/test_latex_installation.R index 342ffd7..2c74733 100644 --- a/R/test_latex_installation.R +++ b/R/test_latex_installation.R @@ -9,10 +9,6 @@ #' #' #' @export -#' @examples -#' \dontrun{ -#' test_latex_installation() -#' } #' test_latex_installation <- function() { tmp <- paste0(tempfile(), ".tex") diff --git a/README.Rmd b/README.Rmd index 4879892..9c8e731 100644 --- a/README.Rmd +++ b/README.Rmd @@ -56,7 +56,9 @@ cli::cli_h1("Next steps.") cli::cli_alert_info("Try running this function again.") cli::cli_alert_info("If you still see this message, run {.fn tinytex::install_tinytex}.") ``` -Ideally, LaTeX automatically installed it self. Try the function again. You -may need to restart `R`. If it still doesn't work, follow the instructions. +Ideally, LaTeX automatically installed itself. Try the function again. You +may need to restart `R`. You may need to restart your machine. +If it still doesn't work, follow the instructions. + If you still get errors, then contact the teaching team on Slack or in Office Hours. diff --git a/README.md b/README.md index 339d52d..658db83 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,9 @@ If it fails, you’ll see: #> ℹ Try running this function again. #> ℹ If you still see this message, run `tinytex::install_tinytex()`. -Ideally, LaTeX automatically installed it self. Try the function again. -You may need to restart `R`. If it still doesn’t work, follow the -instructions. If you still get errors, then contact the teaching team on -Slack or in Office Hours. +Ideally, LaTeX automatically installed itself. Try the function again. +You may need to restart `R`. You may need to restart your machine. If it +still doesn’t work, follow the instructions. + +If you still get errors, then contact the teaching team on Slack or in +Office Hours.