Merge pull request #80 from ThinkR-open/sub-cran

chore: clean roxygen doc and test tempfiles
ThinkR-open · Aug 12, 2024 · 8a3df24 · 8a3df24
2 parents 739fb16 + 597688d
commit 8a3df24
Show file tree

Hide file tree

Showing 14 changed files with 26 additions and 14 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -19,3 +19,5 @@ tests/testthat/.dockerignore
 ^cran-comments\.md$
 ^CRAN-SUBMISSION$
 ^revdep$
+^doc$
+^Meta$
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,5 @@
 .RData
 inst/doc
 revdep/
+/doc/
+/Meta/
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -43,4 +43,4 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
diff --git a/R/add.R b/R/add.R
@@ -1,6 +1,6 @@
 #' @importFrom glue glue
 #' @importFrom attempt warn_if_not
-
+#' @noRd
 create_dockerfile <- function(
   FROM = "rocker/r-base",
   AS = NULL

diff --git a/R/dock_from_desc.R b/R/dock_from_desc.R
@@ -63,7 +63,7 @@ quote_not_na <- function(x){
 #' @importFrom usethis use_build_ignore
 #' @importFrom pkgbuild build
 #'
-#' @export
+#' @return Dockerfile
 dock_from_desc <- function(
   path = "DESCRIPTION",
   FROM = paste0(

diff --git a/R/dock_from_renv.R b/R/dock_from_renv.R
@@ -1,6 +1,7 @@
 # WARNING - Generated by {fusen} from dev/flat_dock_from_renv.Rmd: do not edit by hand
 
 #' @importFrom memoise memoise
+#' @noRd
 pkg_sysreqs_mem <- memoise::memoise(
     pak::pkg_sysreqs
 )

diff --git a/R/parse-dockerfile.R b/R/parse-dockerfile.R
@@ -4,7 +4,7 @@
 #' Create a Dockerfile object from a Dockerfile.
 #'
 #' @param path path to the Dockerfile
-#' @returns A Dockerfile object
+#' @return A Dockerfile object
 #' @export
 #' @examples
 #' parse_dockerfile(system.file("Dockerfile", package = "dockerfiler"))

diff --git a/R/utils.R b/R/utils.R
@@ -4,6 +4,7 @@ set_name <- function(x, y) {
 }
 
 #' @importFrom cli cat_bullet
+#' @noRd
 cat_green_tick <- function(...) {
   cat_bullet(
     ...,
@@ -13,6 +14,7 @@ cat_green_tick <- function(...) {
 }
 
 #' @importFrom cli cat_bullet
+#' @noRd
 cat_red_bullet <- function(...) {
   cat_bullet(
     ...,
@@ -22,6 +24,7 @@ cat_red_bullet <- function(...) {
 }
 
 #' @importFrom cli cat_bullet
+#' @noRd
 cat_info <- function(...) {
   cat_bullet(
     ...,

diff --git a/README.Rmd b/README.Rmd
@@ -16,7 +16,7 @@ knitr::opts_chunk$set(
 
 <!-- badges: start -->
 [![R-CMD-check](https://github.com/ThinkR-open/dockerfiler/workflows/R-CMD-check/badge.svg)](https://github.com/ThinkR-open/dockerfiler/actions)
-[![Coverage status](https://codecov.io/gh/ThinkR-open/dockerfiler/branch/master/graph/badge.svg)](https://codecov.io/github/ThinkR-open/dockerfiler?branch=master)
+[![Coverage status](https://codecov.io/gh/ThinkR-open/dockerfiler/branch/master/graph/badge.svg)](https://app.codecov.io/github/ThinkR-open/dockerfiler?branch=master)
 <!-- badges: end -->
 
 

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 [![R-CMD-check](https://github.com/ThinkR-open/dockerfiler/workflows/R-CMD-check/badge.svg)](https://github.com/ThinkR-open/dockerfiler/actions)
 [![Coverage
-status](https://codecov.io/gh/ThinkR-open/dockerfiler/branch/master/graph/badge.svg)](https://codecov.io/github/ThinkR-open/dockerfiler?branch=master)
+status](https://codecov.io/gh/ThinkR-open/dockerfiler/branch/master/graph/badge.svg)](https://app.codecov.io/github/ThinkR-open/dockerfiler?branch=master)
 <!-- badges: end -->
 
 # `{dockerfiler}`

diff --git a/dev/flat_dock_from_renv.Rmd b/dev/flat_dock_from_renv.Rmd
@@ -45,6 +45,7 @@ if (!is.null(distro)){
 
 ```{r function-dock_from_renv}
 #' @importFrom memoise memoise
+#' @noRd
 pkg_sysreqs_mem <- memoise::memoise(
     pak::pkg_sysreqs
 )
@@ -411,10 +412,6 @@ skip_if(is_rdevel, "skip on R-devel")
 
 
 
-
-
-unlink(dir_build)
-
 # repos_as_character ----
 test_that("repos_as_character works", {
   out <- dockerfiler:::repos_as_character(
@@ -498,6 +495,8 @@ socle_install_version <- "remotes::install_version\\(\"renv\", version = \""
 
 })
 
+unlink(dir_build, recursive = TRUE)
+
 ```
 
 

diff --git a/man/dockerfiles.Rd b/man/dockerfiles.Rd
diff --git a/tests/testthat/test-dock_from_desc.R b/tests/testthat/test-dock_from_desc.R
@@ -109,8 +109,12 @@ withr::with_dir(
         )
       )
 
+      unlink(tpf, recursive = TRUE)
+
 
 
     })
   }
 )
+
+unlink(descdir, recursive = TRUE)
diff --git a/tests/testthat/test-dock_from_renv.R b/tests/testthat/test-dock_from_renv.R
@@ -116,10 +116,6 @@ skip_if(is_rdevel, "skip on R-devel")
 
 
 
-
-
-unlink(dir_build)
-
 # repos_as_character ----
 test_that("repos_as_character works", {
   out <- dockerfiler:::repos_as_character(
@@ -203,3 +199,5 @@ socle_install_version <- "remotes::install_version\\(\"renv\", version = \""
 
 })
 
+unlink(dir_build, recursive = TRUE)
+
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,3 +3,5 @@ @@
     .RData
     inst/doc
     revdep/
+    /doc/
+    /Meta/