From 9640b2039960baf52c3e260d1b6686eda444e539 Mon Sep 17 00:00:00 2001
From: richardjtelford
Date: Wed, 15 Mar 2023 16:30:02 +0100
Subject: [PATCH] docs with cran badge
---
README.Rmd | 1 +
README.md | 23 ++++---
docs/404.html | 5 +-
docs/LICENSE-text.html | 5 +-
docs/LICENSE.html | 5 +-
docs/authors.html | 13 ++--
docs/index.html | 31 +++++-----
docs/news/index.html | 89 ++++++++++++++++++++++++++++
docs/pkgdown.yml | 2 +-
docs/reference/chk_make.html | 22 +++++--
docs/reference/chk_requirements.html | 31 ++++++----
docs/reference/index.html | 5 +-
docs/sitemap.xml | 3 +
13 files changed, 179 insertions(+), 56 deletions(-)
create mode 100644 docs/news/index.html
diff --git a/README.Rmd b/README.Rmd
index a256bfc..3e63f58 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -17,6 +17,7 @@ knitr::opts_chunk$set(
[![R-CMD-check](https://github.com/richardjtelford/checker/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/richardjtelford/checker/actions/workflows/R-CMD-check.yaml)
+[![CRAN status](https://www.r-pkg.org/badges/version/checker)](https://CRAN.R-project.org/package=checker)
One of the challenges with teaching R is that some students come to practicals with very old versions of R, or without critical packages installed.
diff --git a/README.md b/README.md
index 6f09b6e..cac33e9 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,8 @@
[![R-CMD-check](https://github.com/richardjtelford/checker/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/richardjtelford/checker/actions/workflows/R-CMD-check.yaml)
+[![CRAN
+status](https://www.r-pkg.org/badges/version/checker)](https://CRAN.R-project.org/package=checker)
One of the challenges with teaching R is that some students come to
@@ -48,21 +50,16 @@ run.
``` r
library(checker)
chk_requirements()
-#> → Date = 2023-03-02 22:56:55
+#> → Date = 2023-03-15 16:28:14
#> → os = Ubuntu 18.04.6 LTS
-#> ✔ RStudio version 2022.12.0.353 is installed
-#> ✔ RStudio option 'save_workspace' set correctly
-#> ✔ RStudio option 'load_workspace' set correctly
-#> ✔ RStudio option 'rainbow_parentheses' set correctly
-#> ✔ RStudio option 'soft_wrap_r_files' set correctly
-#> ✔ RStudio option 'insert_native_pipe_operator' set correctly
+#> ✖ Are you using RStudio?
#> ✔ R version 4.2.2 is installed
-#> ✔ quarto version 1.2.313 is installed
+#> ✔ quarto version 1.3.262 is installed
#> ✔ git version 2.17.1 is installed
-#> ✔ tidyverse version 1.3.2 is installed
+#> ✔ tidyverse version 2.0.0 is installed
#> ✔ here version 1.0.1 is installed
#> ✔ quarto version 1.2 is installed
-#> ✔ Everything appears to be installed correctly
+#> ✖ You have some issues that need addressing
```
By default, `chk_requirements()` uses a yaml file included in the
@@ -83,15 +80,15 @@ included in these data.frames.
---
R:
- recommended: 4.2.1
+ recommended: 4.2.2
minimum: 4.1.0
packages:
tidyverse:
- recommended: 1.3.1
+ recommended: 2.0.0
here: NA
quarto: NA
rstudio:
- recommended: 2022.07.1
+ recommended: 2022.12.0
options:
save_workspace:
value: never
diff --git a/docs/404.html b/docs/404.html
index e4c77ec..390e859 100644
--- a/docs/404.html
+++ b/docs/404.html
@@ -32,7 +32,7 @@
checker
- 0.1.0
+ 0.1.1
@@ -40,6 +40,9 @@
@Manual{,
- title = {checker: Checks R Configuration Setup Correctly Before Class},
+ title = {checker: Checks 'R' Configuration Set Up Correctly Before Class},
author = {Richard J. Telford},
year = {2023},
- note = {R package version 0.1.0},
+ note = {R package version 0.1.1},
url = {https://github.com/richardjtelford/checker/},
}
diff --git a/docs/index.html b/docs/index.html
index 2a323a7..a46e9ef 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -5,13 +5,13 @@
-Checks R Configuration Setup Correctly Before Class • checker
+Checks R Configuration Set Up Correctly Before Class • checker
-
+
@@ -35,7 +35,7 @@
checker
- 0.1.0
+ 0.1.1
library(checker)chk_requirements()
-#> → Date = 2023-03-02 22:56:55
+#> → Date = 2023-03-15 16:28:14#> → os = Ubuntu 18.04.6 LTS
-#> ✔ RStudio version 2022.12.0.353 is installed
-#> ✔ RStudio option 'save_workspace' set correctly
-#> ✔ RStudio option 'load_workspace' set correctly
-#> ✔ RStudio option 'rainbow_parentheses' set correctly
-#> ✔ RStudio option 'soft_wrap_r_files' set correctly
-#> ✔ RStudio option 'insert_native_pipe_operator' set correctly
+#> ✖ Are you using RStudio?#> ✔ R version 4.2.2 is installed
-#> ✔ quarto version 1.2.313 is installed
+#> ✔ quarto version 1.3.262 is installed#> ✔ git version 2.17.1 is installed
-#> ✔ tidyverse version 1.3.2 is installed
+#> ✔ tidyverse version 2.0.0 is installed#> ✔ here version 1.0.1 is installed#> ✔ quarto version 1.2 is installed
-#> ✔ Everything appears to be installed correctly
+#> ✖ You have some issues that need addressing
By default, chk_requirements() uses a yaml file included in the installation. To run chk_requirements() with your own set of requirements, you can use a URL or file path.
The yaml filechk_make() which takes data.frames of recommended programs, packages, and RStudio options as arguments. Recommended and/or minimum version and any message can be included in these data.frames.
Returns a the yaml, invisibly, as a character vector.
+Main purpose is to write the yaml to a file.
+
Details
Programs are checked against names of programs known by checker.
Unknown programs are ignored with a message. packages are checked against
installed packages. A message is given if there are any unknown packages.
-options are checked against a curated list of RStudio options taken
+options are checked against a curated list of 'RStudio' options taken
from usethis:::rstudio_prefs_read().
See also https://docs.posit.co/ide/server-pro/session_user_settings/session_user_settings.html.
A message is given if any are not recognised.
@@ -92,8 +102,8 @@
Examples
)prog<-read.csv(text ='program, recommended, minimum, message
- rstudio, 2022.7.1.554, NA, NA
- R, "4.2.1", "4.1.1", NA
+ rstudio, 2022.12.0.353, NA, NA
+ R, "4.2.2", "4.1.1", NA git, NA, NA, NA', strip.white =TRUE)opt<-read.csv(text ='option, value, message
@@ -103,7 +113,7 @@
diff --git a/docs/reference/chk_requirements.html b/docs/reference/chk_requirements.html
index 327c2aa..2e9fa3c 100644
--- a/docs/reference/chk_requirements.html
+++ b/docs/reference/chk_requirements.html
@@ -1,5 +1,5 @@
-Check R set up before a class — chk_requirements • checkerCheck R set up before a class — chk_requirements • checker