Skip to content

Commit

Permalink
Make use of quarto callouts for notes
Browse files Browse the repository at this point in the history
  • Loading branch information
peterdesmet committed Sep 25, 2024
1 parent 9cfa7f8 commit 523d47d
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 12 deletions.
10 changes: 8 additions & 2 deletions vignettes/data-package.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ knitr::opts_chunk$set(

[Data Package](https://specs.frictionlessdata.io/data-package/) is a simple container format to describe a coherent collection of data (a dataset), including its contributors, licenses, etc.

_In this document we use the terms "package" for Data Package, "resource" for Data Resource, "dialect" for Table Dialect, and "schema" for Table Schema._
::: {.callout-info}
In this document we use the terms "package" for Data Package, "resource" for Data Resource, "dialect" for Table Dialect, and "schema" for Table Schema.
:::

## General implementation

Expand Down Expand Up @@ -65,7 +67,11 @@ invalid_package$resources <- NULL
check_package(invalid_package)
```

You can manipulate the package list, but frictionless does not provide functions to do that. Use `{purrr}` or base R instead (see `vignette("frictionless")`). Note however that some functions (e.g. `unclass()` or `append()`) removes the custom class, creating an invalid package. You can fix this by calling `create_package()` on your package.
You can manipulate the package list, but frictionless does not provide functions to do that. Use `{purrr}` or base R instead (see `vignette("frictionless")`).

::: {.callout-warning}
Some functions (e.g. `unclass()` or `append()`) remove the custom class, creating an invalid package. You can fix this by calling `create_package()` on your package.
:::

Most functions have `package` as their first argument and return package. This allows you to **pipe the functions**:

Expand Down
12 changes: 9 additions & 3 deletions vignettes/data-resource.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ knitr::opts_chunk$set(

[Data Resource](https://specs.frictionlessdata.io/data-resource/) is a simple format to describe a data resource such as an individual table or file, including its name, format, path, etc.

_In this document we use the terms "package" for Data Package, "resource" for Data Resource, "dialect" for Table Dialect, and "schema" for Table Schema._
::: {.callout-info}
In this document we use the terms "package" for Data Package, "resource" for Data Resource, "dialect" for Table Dialect, and "schema" for Table Schema.
:::

## General implementation

Expand Down Expand Up @@ -65,7 +67,9 @@ path <- system.file("extdata", "v1", "deployments.csv", package = "frictionless"
add_resource(package, "deployments", data = path, replace = TRUE)
```

Note that you can pipe most functions (see `vignette("data-package")`).
::: {.callout-info}
You can pipe most functions (see `vignette("data-package")`).
:::

### Write

Expand Down Expand Up @@ -111,7 +115,9 @@ add_resource(package, "deployments", data = path, replace = TRUE)

### data

_Note: Support for inline `data` is currently limited, e.g. JSON object and string are not supported and `schema`, `mediatype` and `format` are ignored._
::: {.callout-warning}
Support for inline `data` is currently limited, e.g. JSON object and string are not supported and `schema`, `mediatype` and `format` are ignored.
:::

`data` is for inline data (included in the `datapackage.json`). `read_resource()` attempts to read `data` if it is provided as a JSON array:

Expand Down
8 changes: 6 additions & 2 deletions vignettes/frictionless.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,9 @@ my_package <-
add_resource(resource_name = "iris", data = iris)
```

Note that you can chain most frictionless functions together using pipes (`%>%` or `|>`), which improves readability.
::: {.callout-info}
You can chain most frictionless functions together using pipes (`%>%` or `|>`), which improves readability.
:::

`my_package` now contains one resource:

Expand Down Expand Up @@ -349,7 +351,9 @@ my_package <- append(my_package, c(title = "My package"), after = 1)
my_package <- create_package(my_package)
```

Note that in the above steps you started a Data Package from scratch with `create_package()`, but you can use the same functionality to edit an existing Data Package read with `read_package()`.
::: {.callout-info}
In the steps above you started a Data Package from scratch with `create_package()`, but you can use the same functionality to edit an existing Data Package read with `read_package()`.
:::

## Write a Data Package

Expand Down
8 changes: 6 additions & 2 deletions vignettes/frictionless.Rmd.orig
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,9 @@ my_package <-
add_resource(resource_name = "iris", data = iris)
```

Note that you can chain most frictionless functions together using pipes (`%>%` or `|>`), which improves readability.
::: {.callout-info}
You can chain most frictionless functions together using pipes (`%>%` or `|>`), which improves readability.
:::

`my_package` now contains one resource:

Expand Down Expand Up @@ -195,7 +197,9 @@ my_package <- append(my_package, c(title = "My package"), after = 1)
my_package <- create_package(my_package)
```

Note that in the above steps you started a Data Package from scratch with `create_package()`, but you can use the same functionality to edit an existing Data Package read with `read_package()`.
::: {.callout-info}
In the steps above you started a Data Package from scratch with `create_package()`, but you can use the same functionality to edit an existing Data Package read with `read_package()`.
:::

## Write a Data Package

Expand Down
10 changes: 8 additions & 2 deletions vignettes/table-dialect.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ knitr::opts_chunk$set(

[Table Dialect](https://specs.frictionlessdata.io/csv-dialect/) (previously called CSV dialect) is a simple format to describe the dialect of a tabular data file, including its delimiter, header rows, escape characters, etc.

_In this document we use the terms "package" for Data Package, "resource" for Data Resource, "dialect" for Table Dialect, and "schema" for Table Schema._
::: {.callout-info}
In this document we use the terms "package" for Data Package, "resource" for Data Resource, "dialect" for Table Dialect, and "schema" for Table Schema.
:::

## General implementation

Expand Down Expand Up @@ -71,7 +73,11 @@ package$resources[[2]]$dialect$delimiter

### escapeChar

[`escapeChar`](https://specs.frictionlessdata.io/csv-dialect/#specification) is ignored by `read_resource()` unless it is `"\\"`. It is passed as `escape_backslash = TRUE` and `escape_double = FALSE` in `readr::read_delim()`. Note that `escapeChar` and `doubleQuote` are mutually exclusive, so you cannot escape with `\"` and `""` in the same file.
[`escapeChar`](https://specs.frictionlessdata.io/csv-dialect/#specification) is ignored by `read_resource()` unless it is `"\\"`. It is passed as `escape_backslash = TRUE` and `escape_double = FALSE` in `readr::read_delim()`.

::: {.callout-warning}
`escapeChar` and `doubleQuote` are mutually exclusive, so you cannot escape with `\"` and `""` in the same file.
:::

### nullSequence

Expand Down
4 changes: 3 additions & 1 deletion vignettes/table-schema.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ knitr::opts_chunk$set(

[Table Schema](https://specs.frictionlessdata.io/table-schema/) is a simple format to describe tabular data, including field names, types, constraints, missing values, foreign keys, etc.

_In this document we use the terms "package" for Data Package, "resource" for Data Resource, "dialect" for Table Dialect, and "schema" for Table Schema._
::: {.callout-info}
In this document we use the terms "package" for Data Package, "resource" for Data Resource, "dialect" for Table Dialect, and "schema" for Table Schema.
:::

## General implementation

Expand Down

0 comments on commit 523d47d

Please sign in to comment.