From d27bbf8404a5b550f34878d1a2d199ca85bc8d05 Mon Sep 17 00:00:00 2001 From: Jim-smith Date: Mon, 2 Feb 2026 22:29:03 +0000 Subject: [PATCH 1/2] fixing web refs and vignettes --- NEWS.md | 2 +- README.md | 2 +- prepare_to_submit_to_CRAN.R | 3 +++ vignettes/examples.Rmd | 5 +++++ vignettes/installation.Rmd | 5 +++++ vignettes/supports.Rmd | 5 +++++ vignettes/welcome.Rmd | 7 ++++++- 7 files changed, 26 insertions(+), 3 deletions(-) diff --git a/NEWS.md b/NEWS.md index 00dd141..3cf74ce 100644 --- a/NEWS.md +++ b/NEWS.md @@ -5,7 +5,7 @@ * Added support for specifying whether suppression is on or off when acro session is started * Added support for toggling suppression dynamically during session via `acro_enable_supression()` and `acro_disable_suppression()` -* Improved documentation in package and at [sacro-tools.org](sacro-tools.org) +* Improved documentation in package and at [https://sacro-tools.org/](https://sacro-tools.org/) * Added Support for variable names with spaces when calling crosstab * Set status of disclosive outputs to 'review' (previously 'fail') when suppression has been applied * Automatically add exception message when applying suppression to an output diff --git a/README.md b/README.md index ed22073..b7c7a54 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ Select the `example-notebook.Rmd` in the bottom-right pane after loading. ### Documentation -The github-pages contains pre-built [documentation](https://ai-sdc.github.io/ACRO-R/). +The github-pages contains pre-built [documentation](https://acro-r.sacro-tools.org/). Additionally, see our [paper describing the SACRO framework](https://doi.org/10.1109/TP.2025.3566052) to learn about its principles-based SDC methodology and usage. diff --git a/prepare_to_submit_to_CRAN.R b/prepare_to_submit_to_CRAN.R index f376ad7..47c4e3a 100644 --- a/prepare_to_submit_to_CRAN.R +++ b/prepare_to_submit_to_CRAN.R @@ -35,5 +35,8 @@ usethis::use_version(which = c("patch", "minor", "major", "dev")[1]) # When you are happy with the package and want to submit it to CRAN, you can do this manually by converting the package source directory into a single bundled file and submit this file to CRAN (https://xmpalantir.wu.ac.at/cransubmit/) devtools::build() +#good diea to run +R CMD build . && R CMD check --as-cran $(ls -t . | head -n1) + # Or if you decide to do the release automatically then you can run this command # devtools::release() diff --git a/vignettes/examples.Rmd b/vignettes/examples.Rmd index c69e3e3..d13ccbe 100644 --- a/vignettes/examples.Rmd +++ b/vignettes/examples.Rmd @@ -1,5 +1,10 @@ --- title: "Examples" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{Examples} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} --- # Examples diff --git a/vignettes/installation.Rmd b/vignettes/installation.Rmd index 2382964..365579b 100644 --- a/vignettes/installation.Rmd +++ b/vignettes/installation.Rmd @@ -1,5 +1,10 @@ --- title: "Installation Guide" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{Installation Guide} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} --- # Installation Guide diff --git a/vignettes/supports.Rmd b/vignettes/supports.Rmd index 25de22c..5e40559 100644 --- a/vignettes/supports.Rmd +++ b/vignettes/supports.Rmd @@ -1,5 +1,10 @@ --- title: "What ACRO-R Supports" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{What ACRO-R Supports} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} --- # What ACRO-R Supports diff --git a/vignettes/welcome.Rmd b/vignettes/welcome.Rmd index 0be5d2b..c9ea853 100644 --- a/vignettes/welcome.Rmd +++ b/vignettes/welcome.Rmd @@ -1,5 +1,10 @@ --- title: "Welcome to ACRO-R" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{Welcome to ACRO-R} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} --- # Welcome to ACRO-R @@ -38,7 +43,7 @@ acro_init(suppress = TRUE) ## Documentation -The github-pages contains pre-built [documentation](https://ai-sdc.github.io/ACRO-R/). +The github-pages contains pre-built [documentation](https://acro-r.sacro-tools.org/index.html). Additionally, see our [paper describing the SACRO framework](https://doi.org/10.1109/TP.2025.3566052) to learn about its principles-based SDC methodology and usage. From 8f71805fc133169ae31fafa35bfe349bcfe26716 Mon Sep 17 00:00:00 2001 From: Jim-smith Date: Mon, 2 Feb 2026 22:38:13 +0000 Subject: [PATCH 2/2] typos --- prepare_to_submit_to_CRAN.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/prepare_to_submit_to_CRAN.R b/prepare_to_submit_to_CRAN.R index 47c4e3a..8977349 100644 --- a/prepare_to_submit_to_CRAN.R +++ b/prepare_to_submit_to_CRAN.R @@ -35,7 +35,7 @@ usethis::use_version(which = c("patch", "minor", "major", "dev")[1]) # When you are happy with the package and want to submit it to CRAN, you can do this manually by converting the package source directory into a single bundled file and submit this file to CRAN (https://xmpalantir.wu.ac.at/cransubmit/) devtools::build() -#good diea to run +#good idea to run R CMD build . && R CMD check --as-cran $(ls -t . | head -n1) # Or if you decide to do the release automatically then you can run this command