feat: export ptype_config

Author: salim-b

DESCRIPTION

@@ -9,6 +9,8 @@ Description: A canonicalized way to R package configuration striving for
 License: AGPL (>= 3)
 URL: https://gitlab.com/rpkg.dev/funky
 BugReports: https://gitlab.com/rpkg.dev/funky/-/issues
+Depends: 
+    R (>= 3.5)
 Imports: 
     checkmate (>= 2.3.2),
     cli (>= 3.6.4),

NAMESPACE

@@ -6,6 +6,7 @@ export(config_val)
 export(config_val_default)
 export(has_config_val)
 export(print_config)
+export(ptype_config)
 importFrom(magrittr,"%!>%")
 importFrom(magrittr,"%$%")
 importFrom(magrittr,"%<>%")

R/funky.gen.R

@@ -178,7 +178,7 @@ has_config_val <- function(key,
 #'
 #' @inheritParams config_val
 #'
-#' @return `r pkgsnip::param_lbl("tibble_cols", cols = colnames(ptype_funky_config))`
+#' @return `r pkgsnip::param_lbl("tibble_cols", cols = colnames(ptype_config))`
 #' @family pkg_config_data
 #' @export
 #'
@@ -205,7 +205,7 @@ config <- function(pkg = utils::packageName(env = parent.frame())) {
 
   # ensure/complement df structure
   funky_config |>
-    vctrs::tib_cast(to = ptype_funky_config) |>
+    vctrs::tib_cast(to = ptype_config) |>
     tidyr::replace_na(replace = list(require = TRUE))
 }
 
@@ -292,6 +292,18 @@ print_config <- function(pkg = utils::packageName(env = parent.frame()),
     pal::pipe_table()
 }
 
+#' Package configuration data prototype
+#'
+#' An empty funky configuration data [tibble][tibble::tbl_df]. E.g. useful to start from when defining funky configuration data via [tibble::add_row()] calls.
+#'
+#' @format `r pkgsnip::return_lbl("tibble_cols", cols = colnames(ptype_config))`
+#' @family pkg_config_data
+#' @export
+#'
+#' @examples
+#' funky::ptype_config
+"ptype_config"
+
 utils::globalVariables(names = c(".",
                                  # tidyselect fns
                                  "any_of",
@@ -337,9 +349,3 @@ opt_name <- function(key,
   paste(pkg, key,
         sep = ".")
 }
-
-ptype_funky_config <- tibble::tibble(key = character(),
-                                     default_value = list(),
-                                     default_value_dynamic = character(),
-                                     require = logical(),
-                                     description = character())

R/sysdata.rda

@@ -213,7 +213,7 @@ has_config_val <- function(key,
 #'
 #' @inheritParams config_val
 #'
-#' @return `r pkgsnip::param_lbl("tibble_cols", cols = colnames(ptype_funky_config))`
+#' @return `r pkgsnip::param_lbl("tibble_cols", cols = colnames(ptype_config))`
 #' @family pkg_config_data
 #' @export
 #'
@@ -240,7 +240,7 @@ config <- function(pkg = utils::packageName(env = parent.frame())) {
   
   # ensure/complement df structure
   funky_config |>
-    vctrs::tib_cast(to = ptype_funky_config) |>
+    vctrs::tib_cast(to = ptype_config) |>
     tidyr::replace_na(replace = list(require = TRUE))
 }
 ```
@@ -340,6 +340,22 @@ print_config <- function(pkg = utils::packageName(env = parent.frame()),
 }
 ```
 
+### `ptype_config`
+
+```{r}
+#' Package configuration data prototype
+#'
+#' An empty funky configuration data [tibble][tibble::tbl_df]. E.g. useful to start from when defining funky configuration data via [tibble::add_row()] calls.
+#'
+#' @format `r pkgsnip::return_lbl("tibble_cols", cols = colnames(ptype_config))`
+#' @family pkg_config_data
+#' @export
+#'
+#' @examples
+#' funky::ptype_config
+"ptype_config"
+```
+
 # INTERNAL
 
 ## Avoid `R CMD check` NOTES about undefined global objects
@@ -403,15 +419,3 @@ opt_name <- function(key,
         sep = ".")
 }
 ```
-
-## Constants
-
-### `ptype_funky_config`
-
-```{r}
-ptype_funky_config <- tibble::tibble(key = character(),
-                                     default_value = list(),
-                                     default_value_dynamic = character(),
-                                     require = logical(),
-                                     description = character())
-```

Rmd/funky.Rmd

@@ -0,0 +1,42 @@
+---
+editor_options:
+  chunk_output_type: console
+---
+
+# NOTES
+
+-   This file is *not* included in the [source package](https://r-pkgs.org/structure.html#sec-source-package) because of the [`.nopurl` suffix in its
+    filename](https://pkgpurl.rpkg.dev/reference/purl_rmd.html#-rmd-files-excluded-from-purling).
+
+-   The chunks below have to be manually executed in order to regenerate the package data.
+
+-   Although the datasets below are saved as ["internal data" in `R/sysdata.rda`](https://r-pkgs.org/data.html#sec-data-sysdata), they can still be exported and
+    documented (by documenting the dataset's quoted name in the main `.Rmd` source file – which only works when the dataset is also `@export`ed), something [not
+    explicitly mentioned](https://coolbutuseless.github.io/2018/12/10/r-packages-internal-and-external-data/) in the book [R
+    Packages](https://r-pkgs.org/data.html#sec-data-data). To do so, you first need to manually add the `export()` directive in the NAMESPACE file since
+    roxygen2 won't add it automatically.
+
+# Define data
+
+## `ptype_funky_config`
+
+```{r}
+ptype_config <- tibble::tibble(key = character(),
+                               default_value = list(),
+                               default_value_dynamic = character(),
+                               require = logical(),
+                               description = character())
+```
+
+# Write data
+
+Save all the small data objects as a single internal file `R/sysdata.rda`. Note that when documenting them, they must be explicitly `@export`ed to be available
+to package users.
+
+```{r}
+usethis::use_data(ptype_config,
+                  internal = TRUE,
+                  overwrite = TRUE,
+                  compress = "xz",
+                  version = 3L)
+```

Rmd/sysdata.nopurl.Rmd

@@ -2,7 +2,7 @@ pandoc: 3.6.3
 pkgdown: 2.1.1.9000
 pkgdown_sha: 87287f602d5889b3ee3ccd82a6c686f6e5874732
 articles: {}
-last_built: 2025-03-05T01:15Z
+last_built: 2025-03-05T20:45Z
 urls:
   reference: https://funky.rpkg.dev/reference
   article: https://funky.rpkg.dev/articles