Merge pull request #292 from UCD-SERG/249-test-devtag-for-internal-do…

…cumentation

add `devtag` for documenting internal functions and use for `df_to_array()`

.Rbuildignore

@@ -24,3 +24,4 @@ allpopsamples_hlye.csv$
 ^README\.qmd$
 ^codecov\.yml$
 ^\.lintr$
+^man/df_to_array\.Rd$

DESCRIPTION

@@ -41,10 +41,12 @@ Imports:
     utils
 Suggests:
     bookdown,
+    devtag (>= 0.0.0.9000),
     DT,
     fs,
     ggbeeswarm,
     knitr,
+    pak,
     parallel,
     readr,
     rmarkdown,
@@ -55,11 +57,13 @@ Suggests:
 LinkingTo: 
     Rcpp
 Config/testthat/edition: 3
+Config/Needs/build: moodymudskipper/devtag
 Encoding: UTF-8
 Language: en-US
 LazyData: true
 NeedsCompilation: no
-Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
 Remotes: 
-    bcgov/ssdtools
+    bcgov/ssdtools,
+    moodymudskipper/devtag
+Roxygen: list(markdown = TRUE, roclets = c("collate", "rd", "namespace", "devtag::dev_roclet"))
+RoxygenNote: 7.3.2

NEWS.md

@@ -20,11 +20,13 @@
 
 * fixed `dplyr::select()` deprecation warning in `df_to_array()` (#276)
 
+* Added `devtag` to package (using `devtag::use_devtag()`) (#292)
+* Added `@dev` tag to `?df_to_array()` (#292)
+
 * Generalized `get_()` and `set_()` methods to be general-purpose
 (no S3 class-specific methods needed yet) (#274).
 
 * Updated GitHub Action files and reformatted `DESCRIPTION` (#268)
-
 * Added `.gitattributes` file (<https://git-scm.com/docs/gitattributes>)
 copied from <https://github.com/tidyverse/ggplot2>
 

R/df_to_array.R

@@ -41,7 +41,7 @@ df.to.array <- function( # nolint: object_name_linter
 #'   serocalculator:::df_to_array(
 #'      dim_var_names = c("parameter", "Species"))
 #' ftable(arr[,,1:5])
-#' @noRd
+#' @dev
 df_to_array <- function(
     df,
     dim_var_names,