cole-brokamp / fr Goto Github PK

this breaks ability to read the fr_tdr; should omit the component entirely if empty when writing to disk?

docker run --rm -it ghcr.io/rocker-org/r-ver:4.2.2

install.packages("remotes")
remotes::install_github("cole-brokamp/[email protected]", repos = "https://packagemanager.rstudio.com/all/__linux__/focal/latest")

library(fr)
as_fr_tdr(mtcars)

returns

Error in `map2()`:
ℹ In index: 1.
ℹ With name: mpg.
Caused by error in `validator()`:
! trying to get slot "name" from an object (class "fr_field") that is not an S4 object 
Run `rlang::last_trace()` to see where the error occurred.
Warning message:
! `name` was not supplied, but was guessed
ℹ specify with `as_fr_tdr(mtcars, name = "my_name")` 

First release:

• usethis::use_news_md()
• usethis::use_cran_comments()
• Update (aspirational) install instructions in README
• Proofread Title: and Description:
• Check that all exported functions have @return and @examples
• Check that Authors@R: includes a copyright holder (role 'cph')
• Check licensing of included files
• Review https://github.com/DavisVaughan/extrachecks

Prepare for release:

• git pull
• urlchecker::url_check()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• git push
• Draft blog post

Submit to CRAN:

• usethis::use_version('minor')
• devtools::submit_cran()
• Approve email

Wait for CRAN...

• Accepted 🎉
• Add preemptive link to blog post in pkgdown news menu
• usethis::use_github_release()
• usethis::use_dev_version(push = TRUE)
• usethis::use_news_md()
• Finish blog post
• Tweet

Frictionless Tabular-Data-Resource

Convert a data frame into a frictionless tabular-data-resource (i.e., fr_tdr object) with as_fr_tdr(). Here, we create some metadata based on ?mtcars:

d_fr <-
  mtcars |>
  tibble::as_tibble() |>
  as_fr_tdr(name = "mtcars",
            version = "0.9.1",
            title = "Motor Trend Car Road Tests",
            homepage = "https://rdrr.io/r/datasets/mtcars.html",
            description = "The data was extracted from the 1974 Motor Trend US magazine, and comprises fuel consumption and 10 aspects of automobile design and performance for 32 automobiles (1973–74 models).")

Print the fr_tdr object to view all of the table-specific metadata descriptors and the underlying data frame:

d_fr

Use str() or pillar::glimpse() to view all field- and table-specific descriptors:

pillar::glimpse(d_fr)
str(d_fr, max.level = 1)

Use fr_desc() to get a list of descriptors, excluding the list of fields:

fr_desc(d_fr)

Add a metadata descriptor for one of the fields in the tabular data resource by using the @ or S7::prop accessor functions from the {S7} package:

d_fr@fields$cyl@title <- "Number of cylinders"
S7::prop(d_fr@fields$gear, "title") <- "Number of forward gears"

d_fr@fields[c("cyl", "gear")]

## d_fr[c("cyl", "gear")]

Add a name metadata descriptor for each field in the fr_tdr object

# TODO

the_tdr <- c(fr_desc(d_fr), list(fields = lapply(d_fr@fields, fr_desc)))

str(the_tdr)

Using str() provides a useful overview of the structure of a fr_tdr object, including all field-specific metadata, table-specific metadata, and the underlying @value data vector:

str(d_fr)

Use fr_schema() to extract the metadata for each field in a list. Pair this with listviewer for an interactive list viewer:

fr_schema(d_fr) |>
    listviewer::jsonedit(mode = "view")

Accessor functions work as they do with data frames and tibbles, but return a fr_field or td_tdr object:

d_fr[["disp"]] |> class()

d_fr$disp |> class()

d_fr["disp"] |> class()

fr_field objects can be used mostly anywhere that the underlying data frame can be used.

lm(mpg ~ cyl + disp + wt, data = d_fr)

Explicitly drop the Frictionless attributes and extract just the underlying data frame with as_data_frame() or as_tibble():

tibble::as_tibble(d_fr)

summary(d_fr)

summary(as_data_frame(d_fr))

An fr_tdr object is essentially a list of fr_fields with table-specific metadata descriptors.

Create a list of fr_fields using fr_field() and use it to create a fr_tdr object:

# TODO add example for list approach

as in codec

and change order of fr_tdr descriptors so that fields comes last (for better printing)