Rename functions

DESCRIPTION

@@ -38,6 +38,7 @@ Imports:
     dplyr,
     httr,
     jsonlite,
+    lifecycle,
     purrr,
     readr (>= 2.1.0),
     rlang,
@@ -50,7 +51,8 @@ Suggests:
     rmarkdown,
     stringi,
     testthat (>= 3.0.0),
-    tibble
+    tibble,
+    withr
 VignetteBuilder: knitr
 Config/testthat/edition: 3
 Encoding: UTF-8

NAMESPACE

@@ -11,7 +11,9 @@ export(problems)
 export(read_package)
 export(read_resource)
 export(remove_resource)
+export(resource_names)
 export(resources)
+export(schema)
 export(write_package)
 import(rlang)
 importFrom(readr,problems)

NEWS.md

@@ -1,5 +1,8 @@
 # frictionless (development version)
 
+* `resources()` is soft-deprecated, please use `resource_names()` instead (#282).
+* `get_schema()` is soft-deprecated, please use `schema()` instead (#282).
+
 # frictionless 1.2.1
 
 * **frictionless now relies on R version 3.6.0 or higher**. Originally it stated version 3.5.0 or higher, but this was not tested and likely not true (#238).

R/add_resource.R

@@ -45,7 +45,7 @@
 #' package <- example_package()
 #'
 #' # List the resources
-#' resources(package)
+#' resource_names(package)
 #'
 #' # Create a data frame
 #' df <- data.frame(
@@ -84,7 +84,7 @@
 #' )
 #'
 #' # List the resources ("positions" and "positions_with_schema" added)
-#' resources(package)
+#' resource_names(package)
 add_resource <- function(package, resource_name, data, schema = NULL,
                          replace = FALSE, delim = ",", ...) {
   # Check package
@@ -111,7 +111,7 @@ add_resource <- function(package, resource_name, data, schema = NULL,
   }
 
   # Check resource does not exist yet for replace = FALSE
-  if (!replace && resource_name %in% resources(package)) {
+  if (!replace && resource_name %in% resource_names(package)) {
     cli::cli_abort(
       c(
         "{.arg package} already contains a resource named
@@ -206,7 +206,7 @@ add_resource <- function(package, resource_name, data, schema = NULL,
     # Add CSV dialect for non-default delimiter or remove it
     resource$dialect <- if (delim != ",") list(delimiter = delim) else NULL
 
-    # Set attribute for get_resource()
+    # Set attribute for resource()
     attr(resource, "path") <- "added"
   }
 

R/deprecated.R

@@ -0,0 +1,35 @@
+#' Deprecated functions
+#'
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' Use [schema()] instead of `get_schema()`.
+#'
+#' @family deprecated functions
+#' @export
+#' @keywords internal
+#' @name deprecated
+get_schema <- function(package, resource_name) {
+  lifecycle::deprecate_soft(
+    "1.3.0",
+    "get_schema()",
+    "schema()"
+  )
+  schema(package, resource_name)
+}
+
+#' @description
+#' Use [resource_names()] instead of `resources()`.
+#'
+#' @family deprecated functions
+#' @export
+#' @keywords internal
+#' @name deprecated
+resources <- function(package) {
+  lifecycle::deprecate_soft(
+    "1.3.0",
+    "resources()",
+    "resource_names()"
+  )
+  resource_names(package)
+}

R/locale.R

@@ -9,10 +9,10 @@
 #' @noRd
 locale <- function(package, resource_name) {
   # Get resource, includes check_package()
-  resource <- get_resource(package, resource_name)
+  resource <- resource(package, resource_name)
 
   # Get fields
-  schema <- get_schema(package, resource_name)
+  schema <- schema(package, resource_name)
   fields <- schema$fields
 
   # Set decimal mark

R/print.R → R/print.datapackage.R

@@ -19,7 +19,7 @@ print.datapackage <- function(x, ...) {
   # All prints should use cat (= cli::cat() helpers)
 
   # List resources
-  resource_names <- resources(x)
+  resource_names <- resource_names(x)
   cli::cat_line(
     cli::format_inline(
       "A Data Package with {length(resource_names)} resource{?s}{?./:/:}"

R/read_from_path.R

@@ -6,11 +6,11 @@
 #' @noRd
 read_from_path <- function(package, resource_name, col_select) {
   # Get resource, includes check_package()
-  resource <- get_resource(package, resource_name)
+  resource <- resource(package, resource_name)
 
   # Get paths, schema and fields
   paths <- resource$path
-  schema <- get_schema(package, resource_name)
+  schema <- schema(package, resource_name)
   fields <- schema$fields
   field_names <- purrr::map_chr(fields, ~ purrr::pluck(.x, "name"))
 

R/read_resource.R

@@ -47,7 +47,7 @@
 #' read_resource(package, "deployments", col_select = c("latitude", "longitude"))
 read_resource <- function(package, resource_name, col_select = NULL) {
   # Get resource, includes check_package()
-  resource <- get_resource(package, resource_name)
+  resource <- resource(package, resource_name)
 
   # Read data directly
   if (resource$read_from == "df") {

R/remove_resource.R

@@ -12,16 +12,16 @@
 #' package <- example_package()
 #'
 #' # List the resources
-#' resources(package)
+#' resource_names(package)
 #'
 #' # Remove the resource "observations"
 #' package <- remove_resource(package, "observations")
 #'
 #' # List the resources ("observations" removed)
-#' resources(package)
+#' resource_names(package)
 remove_resource <- function(package, resource_name) {
   # Check resource is present, includes check_package()
-  resource <- get_resource(package, resource_name)
+  resource <- resource(package, resource_name)
 
   # Remove resource
   package$resources <- purrr::discard(package$resources, function(x) {

R/get_resource.R → R/resource.R

@@ -9,12 +9,12 @@
 #'   If present, `path` will be updated to contain the full path(s).
 #' @family accessor functions
 #' @noRd
-get_resource <- function(package, resource_name) {
+resource <- function(package, resource_name) {
   # Check package
   check_package(package)
 
   # Check resource
-  resource_names <- resources(package)
+  resource_names <- resource_names(package)
   if (!resource_name %in% resource_names) {
     cli::cli_abort(
       c(

R/resources.R → R/resource_names.R

@@ -1,18 +1,18 @@
-#' List Data Resources
+#' List Data Resource names
 #'
 #' Lists the names of the Data Resources included in a Data Package.
 #'
 #' @inheritParams read_resource
 #' @return Character vector with the Data Resource names.
-#' @family read functions
+#' @family accessor functions
 #' @export
 #' @examples
 #' # Load the example Data Package
 #' package <- example_package()
 #'
 #' # List the resources
-#' resources(package)
-resources <- function(package) {
+#' resource_names(package)
+resource_names <- function(package) {
   # Check package (and that all resource have a name)
   check_package(package)
 

R/get_schema.R → R/schema.R

@@ -17,11 +17,11 @@
 #' package <- example_package()
 #'
 #' # Get the Table Schema for the resource "observations"
-#' schema <- get_schema(package, "observations")
+#' schema <- schema(package, "observations")
 #' str(schema)
-get_schema <- function(package, resource_name) {
+schema <- function(package, resource_name) {
   # Get resource
-  resource <- get_resource(package, resource_name)
+  resource <- resource(package, resource_name)
 
   # Check resource is tabular-data-resource (expected for resources with schema)
   if (resource$profile %||% "" != "tabular-data-resource") {

R/write_resource.R

@@ -11,7 +11,7 @@
 write_resource <- function(package, resource_name, directory = ".",
                            compress = FALSE) {
   # Get resource, includes check_package()
-  resource <- get_resource(package, resource_name)
+  resource <- resource(package, resource_name)
 
   # Resource contains new data
   if (resource$read_from == "df") {

README.Rmd

@@ -69,7 +69,7 @@ package <- read_package("https://zenodo.org/records/10053702/files/datapackage.j
 package
 
 # List resources
-resources(package)
+resource_names(package)
 
 # Read data from the resource "gps"
 # This will return a single data frame, even though the data are split over 

README.md

@@ -84,7 +84,7 @@ package
 #> Use `unclass()` to print the Data Package as a list.
 
 # List resources
-resources(package)
+resource_names(package)
 #> [1] "reference-data" "gps"            "acceleration"
 
 # Read data from the resource "gps"