Create a v2 example_package()

R/add_resource.R

@@ -70,8 +70,10 @@
 #' )
 #'
 #' # Replace the resource "observations" with a file-based resource (2 TSV files)
-#' path_1 <- system.file("extdata", "observations_1.tsv", package = "frictionless")
-#' path_2 <- system.file("extdata", "observations_2.tsv", package = "frictionless")
+#' path_1 <-
+#' system.file("extdata", "v1", "observations_1.tsv", package = "frictionless")
+#' path_2 <-
+#' system.file("extdata", "v1", "observations_2.tsv", package = "frictionless")
 #' package <- add_resource(
 #'   package,
 #'   resource_name = "observations",

R/example_package.R

@@ -9,12 +9,24 @@
 #'    `"path": ["observations_1.tsv", "observations_2.tsv"]`.
 #' 3. `media`: inline data stored in `data`.
 #'
+#' @param version Version of the [Data Package](
+#' https://datapackage.org/blog/2024-06-26-v2-release/) standard that this
+#' example Data Package uses. Currently only version 1 is supported.
 #' @return A Data Package object, see [create_package()].
 #' @family sample data
 #' @export
 #' @examples
 #' example_package()
-example_package <- function() {
-  path <- system.file("extdata", "datapackage.json", package = "frictionless")
+example_package <- function(version = 1) {
+  if (!version %in% c(1, "1", 1.0, "1.0")) {
+    cli::cli_abort(
+      "Currently only version 1 (`version = 1`) is supported.",
+      class = "frictionless_error_example_package_version_invalid"
+    )
+  } else {
+    path <- system.file(
+      "extdata", "v1", "datapackage.json", package = "frictionless"
+    )
+  }
   read_package(path)
 }

R/read_package.R

@@ -14,7 +14,7 @@
 #' @examples
 #' # Read a datapackage.json file
 #' package <- read_package(
-#'   system.file("extdata", "datapackage.json", package = "frictionless")
+#'   system.file("extdata", "v1", "datapackage.json", package = "frictionless")
 #' )
 #'
 #' package

R/read_resource.R

@@ -28,7 +28,7 @@
 #' @examples
 #' # Read a datapackage.json file
 #' package <- read_package(
-#'   system.file("extdata", "datapackage.json", package = "frictionless")
+#'   system.file("extdata", "v1", "datapackage.json", package = "frictionless")
 #' )
 #'
 #' package

R/write_package.R

@@ -24,7 +24,7 @@
 #' @examples
 #' # Load the example Data Package from disk
 #' package <- read_package(
-#'   system.file("extdata", "datapackage.json", package = "frictionless")
+#'   system.file("extdata", "v1", "datapackage.json", package = "frictionless")
 #' )
 #'
 #' package

tests/testthat/test-add_resource.R

@@ -338,7 +338,7 @@ test_that("add_resource() can add resource from local, relative, absolute,
 
   # Absolute (doesn't throw unsafe error)
   absolute_path <- system.file(
-    "extdata", "deployments.csv", package = "frictionless" # Will start with /
+    "extdata", "v1", "deployments.csv", package = "frictionless" # Will start with /
   )
   p <- add_resource(p, "absolute", absolute_path, schema)
   expect_identical(p$resources[[6]]$path, absolute_path)
@@ -377,7 +377,7 @@ test_that("add_resource() can add resource from CSV file with other delimiter,
 
 test_that("add_resource() sets correct properties for CSV resources", {
   p <- create_package()
-  path <- system.file("extdata", "deployments.csv", package = "frictionless")
+  path <- system.file("extdata", "v1", "deployments.csv", package = "frictionless")
 
   # Encoding UTF-8 (0.8), ISO-8859-1 (0.59), ISO-8859-2 (0.26)
   p <- add_resource(p, "deployments", path)

tests/testthat/test-example_package.R

@@ -0,0 +1,14 @@
+test_that("example_package() returns error on invalid version", {
+  expect_error(
+    example_package("2"),
+    class = "frictionless_error_example_package_version_invalid"
+  )
+  expect_error(
+    example_package(2),
+    class = "frictionless_error_example_package_version_invalid"
+  )
+  expect_error(
+    example_package(2.0),
+    class = "frictionless_error_example_package_version_invalid"
+  )
+})

tests/testthat/test-read_package.R

@@ -1,6 +1,6 @@
 test_that("read_package() returns a valid Data Package reading from path", {
   # Load example package and a valid minimal one
-  p_path <- system.file("extdata", "datapackage.json", package = "frictionless")
+  p_path <- system.file("extdata", "v1", "datapackage.json", package = "frictionless")
   minimal_path <- test_path("data/valid_minimal.json")
   p_local <- read_package(p_path)
   p_minimal <- read_package(minimal_path)
@@ -67,7 +67,7 @@ test_that("read_package() returns error on missing file and properties", {
   # Not a json file
   expect_error(
     read_package(
-      system.file("extdata", "deployments.csv", package = "frictionless")
+      system.file("extdata", "v1", "deployments.csv", package = "frictionless")
     ),
     regexp = "lexical error: invalid char in json text.",
     fixed = FALSE
@@ -119,7 +119,7 @@ test_that("read_package() allows YAML descriptor", {
 })
 
 test_that("read_package() converts JSON null to NULL", {
-  p_path <- system.file("extdata", "datapackage.json", package = "frictionless")
+  p_path <- system.file("extdata", "v1", "datapackage.json", package = "frictionless")
   p <- read_package(p_path)
   # { "image": null } is read as NULL (use chuck() to force error if missing)
   expect_null(purrr::chuck(p, "image"))

tests/testthat/test-read_resource.R

@@ -198,7 +198,7 @@ test_that("read_resource() returns error on invalid resource", {
   # Add valid path
   p_invalid$resources[[1]]$path <- "deployments.csv"
   p_invalid$directory <- dirname(
-    system.file("extdata", "datapackage.json", package = "frictionless")
+    system.file("extdata", "v1", "datapackage.json", package = "frictionless")
   )
 
   # Not a tabular-data-resource
@@ -288,7 +288,7 @@ test_that("read_resource() can read local files", {
   resource <- read_resource(p, "deployments")
 
   p_local <- read_package(
-    system.file("extdata", "datapackage.json", package = "frictionless")
+    system.file("extdata", "v1", "datapackage.json", package = "frictionless")
   )
   expect_identical(read_resource(p_local, "deployments"), resource)
 })

tests/testthat/test-write_package.R

@@ -45,7 +45,8 @@ test_that("write_package() returns error if Data Package has no resource(s)", {
 })
 
 test_that("write_package() writes unaltered datapackage.json as is", {
-  p_file <- system.file("extdata", "datapackage.json", package = "frictionless")
+  p_file <-
+    system.file("extdata", "v1", "datapackage.json", package = "frictionless")
   json_original <- readr::read_lines(p_file) # Will use line endings of system
   p <- read_package(p_file)
   dir <- file.path(tempdir(), "package")

vignettes/data-package.Rmd

@@ -29,7 +29,7 @@ Frictionless supports reading, manipulating and writing packages. Much of its fu
 
 ```{r}
 library(frictionless)
-file <- system.file("extdata", "datapackage.json", package = "frictionless")
+file <- system.file("extdata", "v1", "datapackage.json", package = "frictionless")
 package <- read_package(file)
 ```
 

vignettes/data-resource.Rmd

@@ -61,7 +61,7 @@ remove_resource(package, "deployments")
 add_resource(package, "iris", data = iris)
 
 # Replace a resource with one where data is stored in a tabular file
-path <- system.file("extdata", "deployments.csv", package = "frictionless")
+path <- system.file("extdata", "v1", "deployments.csv", package = "frictionless")
 add_resource(package, "deployments", data = path, replace = TRUE)
 ```
 
@@ -105,7 +105,7 @@ read_resource(package, "observations")
 `add_resource()` sets `path` to the path(s) provided in `data`:
 
 ```{r}
-path <- system.file("extdata", "deployments.csv", package = "frictionless")
+path <- system.file("extdata", "v1", "deployments.csv", package = "frictionless")
 add_resource(package, "deployments", data = path, replace = TRUE)
 ```
 
@@ -176,7 +176,7 @@ delim | format
 any other value | `"csv"`
 
 ```{r}
-path <- system.file("extdata", "observations_1.tsv", package = "frictionless")
+path <- system.file("extdata", "v1", "observations_1.tsv", package = "frictionless")
 package <- add_resource(package, "observations", data = path, delim = "\t", replace = TRUE)
 package$resources[[2]]$format
 ```
@@ -194,7 +194,7 @@ delim | mediatype
 any other value | `"text/csv"`
 
 ```{r}
-path <- system.file("extdata", "observations_1.tsv", package = "frictionless")
+path <- system.file("extdata", "v1", "observations_1.tsv", package = "frictionless")
 package <- add_resource(package, "observations", data = path, delim = "\t", replace = TRUE)
 package$resources[[2]]$mediatype
 ```
@@ -208,7 +208,7 @@ package$resources[[2]]$mediatype
 `add_resource()` guesses the `encoding` (using `readr::guess_encoding()`) when data are provided as file. It leaves the `encoding` undefined when data are provided as a data frame. `write_package()` sets it to `"utf-8"` when writing to disk.
 
 ```{r}
-path <- system.file("extdata", "deployments.csv", package = "frictionless")
+path <- system.file("extdata", "v1", "deployments.csv", package = "frictionless")
 package <- add_resource(package, "deployments", data = path, delim = ",", replace = TRUE)
 package$resources[[2]]$encoding
 ```

vignettes/frictionless.Rmd

@@ -114,7 +114,7 @@ You can also read data from a local (e.g. downloaded) Data Package. In fact, the
 
 ``` r
 local_package <- read_package(
-  system.file("extdata", "datapackage.json", package = "frictionless")
+  system.file("extdata", "v1", "datapackage.json", package = "frictionless")
 )
 
 local_package
@@ -327,8 +327,8 @@ If you already have your data stored as CSV or TSV files and you want to include
 
 ``` r
 # Two TSV files with the same structure
-path_1 <- system.file("extdata", "observations_1.tsv", package = "frictionless")
-path_2 <- system.file("extdata", "observations_2.tsv", package = "frictionless")
+path_1 <- system.file("extdata", "v1", "observations_1.tsv", package = "frictionless")
+path_2 <- system.file("extdata", "v1", "observations_2.tsv", package = "frictionless")
 
 # Add both TSV files as a single resource
 my_package <-

vignettes/frictionless.Rmd.orig

@@ -64,7 +64,7 @@ You can also read data from a local (e.g. downloaded) Data Package. In fact, the
 
 ```{r}
 local_package <- read_package(
-  system.file("extdata", "datapackage.json", package = "frictionless")
+  system.file("extdata", "v1", "datapackage.json", package = "frictionless")
 )
 
 local_package
@@ -171,8 +171,8 @@ If you already have your data stored as CSV or TSV files and you want to include
 
 ```{r}
 # Two TSV files with the same structure
-path_1 <- system.file("extdata", "observations_1.tsv", package = "frictionless")
-path_2 <- system.file("extdata", "observations_2.tsv", package = "frictionless")
+path_1 <- system.file("extdata", "v1", "observations_1.tsv", package = "frictionless")
+path_2 <- system.file("extdata", "v1", "observations_2.tsv", package = "frictionless")
 
 # Add both TSV files as a single resource
 my_package <-

vignettes/table-dialect.Rmd

@@ -52,7 +52,7 @@ Frictionless does not support direct manipulation of the dialect. `add_resource(
 library(frictionless)
 package <- example_package()
 
-path <- system.file("extdata", "observations_1.tsv", package = "frictionless")
+path <- system.file("extdata", "v1", "observations_1.tsv", package = "frictionless")
 package <- add_resource(package, "observations", data = path, delim = "\t", replace = TRUE)
 package$resources[[2]]$dialect$delimiter
 ```