Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -25,32 +25,30 @@ knitr::opts_chunk$set(
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5815355.svg)](https://doi.org/10.5281/zenodo.5815355)
<!-- badges: end -->

Frictionless is an R package to 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](https://www.go-fair.org/fair-principles/) and open datasets.
frictionless is an R package to 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](https://www.go-fair.org/fair-principles/) and open datasets.

To get started, see:

- [Get started](https://docs.ropensci.org/frictionless/articles/frictionless.html): an introduction to the package's main functionalities.
- [Function reference](https://docs.ropensci.org/frictionless/reference/index.html): overview of all functions.
- [Standard implementation](https://docs.ropensci.org/frictionless/articles/index.html): how frictionless implements the Data Package standard.

**Frictionless currently implements [Data Package v1](https://specs.frictionlessdata.io/).** Our goal is to support [Data Package v2](https://datapackage.org/) as well.
**frictionless currently implements [Data Package v1](https://specs.frictionlessdata.io/).** Our goal is to support [Data Package v2](https://datapackage.org/) as well.

## Installation

Install the latest released version from CRAN:
Install the released version of frictionless from CRAN:

```{r, eval = FALSE}
``` r
install.packages("frictionless")
```

Or the development version from [GitHub](https://github.com/frictionlessdata/frictionless-r) or [R-universe](https://ropensci.r-universe.dev/frictionless):
Or install the development version from [GitHub](https://github.com/)
with:

```{r, eval = FALSE}
# install.packages("devtools")
devtools::install_github("frictionlessdata/frictionless-r")

# Or rOpenSci R-universe
install.packages("frictionless", repos = "https://ropensci.r-universe.dev")
``` r
# install.packages("pak")
pak::pak("frictionlessdata/frictionless-r")
```

## Usage
Expand Down Expand Up @@ -105,7 +103,7 @@ frictionless on the other hand allows you to quickly read and write Data Package

## Meta

- We welcome [contributions](https://docs.ropensci.org/frictionless/CONTRIBUTING.html) including bug reports.
- We welcome [contributions](.github/CONTRIBUTING.md) including bug reports.
- License: MIT
- Get [citation information](https://docs.ropensci.org/frictionless/authors.html#citation) for frictionless in R doing `citation("frictionless")`.
- Please note that this project is released with a [Contributor Code of Conduct](https://frictionlessdata.io/work-with-us/code-of-conduct/). By participating in this project you agree to abide by its terms.
- Get citation information for frictionless in R with `citation("frictionless")`.
- Please note that this project is released with a [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
32 changes: 13 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repost
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5815355.svg)](https://doi.org/10.5281/zenodo.5815355)
<!-- badges: end -->

Frictionless is an R package to read and write Frictionless Data
frictionless is an R package to 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
Expand All @@ -36,28 +36,24 @@ To get started, see:
implementation](https://docs.ropensci.org/frictionless/articles/index.html):
how frictionless implements the Data Package standard.

**Frictionless currently implements [Data Package
**frictionless currently implements [Data Package
v1](https://specs.frictionlessdata.io/).** Our goal is to support [Data
Package v2](https://datapackage.org/) as well.

## Installation

Install the latest released version from CRAN:
Install the released version of frictionless from CRAN:

``` r
install.packages("frictionless")
```

Or the development version from
[GitHub](https://github.com/frictionlessdata/frictionless-r) or
[R-universe](https://ropensci.r-universe.dev/frictionless):
Or install the development version from [GitHub](https://github.com/)
with:

``` r
# install.packages("devtools")
devtools::install_github("frictionlessdata/frictionless-r")

# Or rOpenSci R-universe
install.packages("frictionless", repos = "https://ropensci.r-universe.dev")
# install.packages("pak")
pak::pak("frictionlessdata/frictionless-r")
```

## Usage
Expand Down Expand Up @@ -154,13 +150,11 @@ for extensive validation.

## Meta

- We welcome
[contributions](https://docs.ropensci.org/frictionless/CONTRIBUTING.html)
including bug reports.
- We welcome [contributions](.github/CONTRIBUTING.md) including bug
reports.
- License: MIT
- Get [citation
information](https://docs.ropensci.org/frictionless/authors.html#citation)
for frictionless in R doing `citation("frictionless")`.
- Get citation information for frictionless in R with
`citation("frictionless")`.
- Please note that this project is released with a [Contributor Code of
Conduct](https://frictionlessdata.io/work-with-us/code-of-conduct/).
By participating in this project you agree to abide by its terms.
Conduct](.github/CODE_OF_CONDUCT.md). By participating in this project
you agree to abide by its terms.
Loading