Merge pull request #71 from frictionlessdata/ropensci-submission

Add vignette and prepare for rOpenSci submission

Author: peterdesmet

.Rbuildignore

@@ -7,3 +7,4 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^cache$

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: frictionless
 Title: Read and Write Frictionless Data Packages
-Version: 0.8.0.9000
+Version: 0.9.0
 Authors@R: c(
     person("Peter", "Desmet", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0002-8442-8025")),
@@ -9,27 +9,32 @@ Authors@R: c(
     person("Research Institute for Nature and Forest (INBO)", , , 
            "[email protected]", role = c("cph"))
   )
-Description: Read and write Frictionless Data Packages in a Tidyverse way.
+Description: Read and write Frictionless Data Packages. A Data Package 
+  (<https://specs.frictionlessdata.io/data-package/>) is a simple container 
+  format and standard to describe and package a collection of (tabular) data. 
+  It is typically used to publish FAIR and open datasets.
 License: MIT + file LICENSE
 URL: https://github.com/frictionlessdata/frictionless-r,
-    https://frictionlessdata.github.io/frictionless-r
+    https://frictionlessdata.github.io/frictionless-r/
 BugReports: https://github.com/frictionlessdata/frictionless-r/issues
 Imports:
     assertthat,
     dplyr,
     glue,
     httr,
     jsonlite,
-    lifecycle,
     purrr,
     readr (>= 2.1.0),
     stringr
 Suggests:
+    knitr,
     hms,
     lubridate,
-    testthat (>= 3.0.0)
+    testthat (>= 3.0.0),
+    rmarkdown
 Config/testthat/edition: 3
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.1.2
+VignetteBuilder: knitr

R/add_resource.R

@@ -1,17 +1,19 @@
 #' Add a Data Resource
 #'
-#' Adds a Tabular
-#' [Data Resource](https://specs.frictionlessdata.io/data-resource/)
-#' to a Data Package. The resource will be a
-#' [Tabular Data Resource](https://specs.frictionlessdata.io/tabular-data-resource/).
+#' Adds a Tabular [Data
+#' Resource](https://specs.frictionlessdata.io/data-resource/) to a Data
+#' Package.
+#' The resource will be a [Tabular Data
+#' Resource](https://specs.frictionlessdata.io/tabular-data-resource/).
 #' The resource name can only contain lowercase alphanumeric characters plus
 #' `.`, `-` and `_`.
 #'
 #' @inheritParams read_resource
 #' @param df A data frame.
-#' @param schema List object describing a Table Schema for that data frame. If
-#'   not provided, one will be created (using [create_schema()]).
+#' @param schema List object describing a Table Schema for that data frame.
+#'   If not provided, one will be created (using [create_schema()]).
 #' @return Provided `package` with one additional resource.
+#' @family edit functions
 #' @export
 #' @examples
 #' # Load the example Data Package

R/check_package.R

@@ -5,6 +5,7 @@
 #'
 #' @param package List object describing a Data Package.
 #' @return `TRUE` or error.
+#' @family check functions
 #' @noRd
 check_package <- function(package) {
   msg_invalid <- glue::glue(

R/check_schema.R

@@ -6,6 +6,7 @@
 #' @param schema List object describing a Table Schema.
 #' @param df A data frame against which the Table Schema must be compared.
 #' @return `TRUE` or error.
+#' @family check functions
 #' @noRd
 check_schema <- function(schema, df = NULL) {
   # Check schema is list with property fields

R/create_package.R

@@ -1,11 +1,12 @@
 #' Create an empty Data Package
 #'
-#' Initiates a list object describing a
-#' [Data Package](https://specs.frictionlessdata.io/data-package/). This empty
-#' Data Package can then be extended with metadata and resources (see
+#' Initiates a list object describing a [Data
+#' Package](https://specs.frictionlessdata.io/data-package/).
+#' This empty Data Package can then be extended with metadata and resources (see
 #' [add_resource()]).
 #'
 #' @return List object describing a Data Package.
+#' @family create functions
 #' @export
 #' @examples
 #' # Create a Data Package

R/create_schema.R

@@ -6,6 +6,7 @@
 #'
 #' @param df A data frame.
 #' @return List object describing a Table Schema.
+#' @family create functions
 #' @export
 #' @section Table schema properties:
 #' The Table Schema will be created from the data frame columns:
@@ -14,14 +15,15 @@
 #' - `title`: not set.
 #' - `description`: not set.
 #' - `type`: contains the converted column type (see further).
-#' - `format`: not set and can thus be considered `default`. This is also the
-#' case for dates, times and datetimes, since [readr::write_csv()] used by
-#' [write_package()] will format those to ISO8601 which is considered the
-#' default. Datetimes in local or non-UTC timezones will be converted to UTC
-#' before writing.
+#' - `format`: not set and can thus be considered `default`.
+#'   This is also the case for dates, times and datetimes, since
+#'   [readr::write_csv()] used by [write_package()] will format those to ISO8601
+#'   which is considered the default.
+#'   Datetimes in local or non-UTC timezones will be converted to UTC before
+#'   writing.
 #' - `constraints`: not set, except for factors (see further).
-#' - `missingValues`: not set. [write_package()] will use the default `""` for
-#' missing values.
+#' - `missingValues`: not set.
+#'   [write_package()] will use the default `""` for missing values.
 #' - `primaryKey`: not set.
 #' - `foreignKeys`: not set.
 #'
@@ -30,25 +32,25 @@
 #' The column type will determine the field `type`, as follows:
 #'
 #' - `character` →
-#' [string](https://specs.frictionlessdata.io/table-schema/#string).
+#'   [string](https://specs.frictionlessdata.io/table-schema/#string).
 #' - `Date` → [date](https://specs.frictionlessdata.io/table-schema/#date).
 #' - `difftime` →
-#' [number](https://specs.frictionlessdata.io/table-schema/#number).
+#'   [number](https://specs.frictionlessdata.io/table-schema/#number).
 #' - `factor` →
-#' [string](https://specs.frictionlessdata.io/table-schema/#string) with factor
-#' levels as `enum`.
+#'   [string](https://specs.frictionlessdata.io/table-schema/#string) with
+#'   factor levels as `enum`.
 #' - [hms::hms()] →
-#' [time](https://specs.frictionlessdata.io/table-schema/#time).
+#'   [time](https://specs.frictionlessdata.io/table-schema/#time).
 #' - `integer` →
-#' [integer](https://specs.frictionlessdata.io/table-schema/#integer).
+#'   [integer](https://specs.frictionlessdata.io/table-schema/#integer).
 #' - `logical` →.
-#' [boolean](https://specs.frictionlessdata.io/table-schema/#boolean).
+#'   [boolean](https://specs.frictionlessdata.io/table-schema/#boolean).
 #' - `numeric` →
-#' [number](https://specs.frictionlessdata.io/table-schema/#number).
+#'   [number](https://specs.frictionlessdata.io/table-schema/#number).
 #' - `POSIXct`/`POSIXlt` →
-#' [datetime](https://specs.frictionlessdata.io/table-schema/#datetime).
+#'   [datetime](https://specs.frictionlessdata.io/table-schema/#datetime).
 #' - Any other type →
-#' [any](https://specs.frictionlessdata.io/table-schema/#any).
+#'   [any](https://specs.frictionlessdata.io/table-schema/#any).
 #' @examples
 #' # Create a data frame
 #' df <- data.frame(

R/data.R

@@ -1,20 +1,24 @@
 #' Example Data Package
 #'
-#' Example Tabular
-#' [Data Package](https://specs.frictionlessdata.io/data-package/) with dummy
-#' camera trap data organized in 3 Data Resources:
+#' Example Tabular [Data
+#' Package](https://specs.frictionlessdata.io/data-package/) with dummy camera
+#' trap data organized in 3 Data Resources:
 #' - `deployments`: data stored in `deployments.csv`.
 #' - `observations`: data stored in `observations_1.csv` and
-#' `observations_2.csv`.
+#'   `observations_2.csv`.
 #' - `media`: data stored in `data` property.
 #'
-#' @source <https://github.com/frictionlessdata/frictionless-r/tree/main/inst/extdata>
+#' @source
+#' <https://github.com/frictionlessdata/frictionless-r/tree/main/inst/extdata>
 #' @examples
 #' \dontrun{
-#' # example_package.rda was created with the following code. Note that it must
-#' # be created using a URL, otherwise all Data Resource paths will point to
-#' # local paths that won't work for other users. One can load locally using:
-#' # read_package(system.file("extdata", "datapackage.json", package = "frictionless"))
+#' # example_package.rda was created with the following code.
+#' # Note that it must be created using a URL, otherwise all Data Resource paths
+#' # will point to local paths that won't work for other users.
+#' # One can load locally using:
+#' # read_package(
+#' #   system.file("extdata", "datapackage.json", package = "frictionless")
+#' # )
 #' example_package <- read_package(file.path(
 #'   "https://raw.githubusercontent.com/frictionlessdata/frictionless-r",
 #'   "main/inst/extdata/datapackage.json"

R/get_resource.R

@@ -5,8 +5,9 @@
 #'
 #' @inheritParams read_resource
 #' @return List object describing a Data Resource, with new property `read_from`
-#'   to indicate how data should be read. If present, `path` will be updated to
-#'   contain the full path(s).
+#'   to indicate how data should be read.
+#'   If present, `path` will be updated to contain the full path(s).
+#' @family edit functions
 #' @noRd
 #' @examples
 #' # Load the example Data Package

R/get_schema.R

@@ -3,11 +3,13 @@
 #' Returns the [Table Schema](https://specs.frictionlessdata.io/table-schema/)
 #' of a Data Resource (in a Data Package), i.e. the content of its `schema`
 #' property, describing the resource's fields, data types, relationships, and
-#' missing values. The resource must be a
-#' [Tabular Data Resource](https://specs.frictionlessdata.io/tabular-data-resource/).
+#' missing values.
+#' The resource must be a [Tabular Data
+#' Resource](https://specs.frictionlessdata.io/tabular-data-resource/).
 #'
 #' @inheritParams read_resource
 #' @return List object describing a Table Schema.
+#' @family edit functions
 #' @export
 #' @examples
 #' # Load the example Data Package