-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.Rmd
More file actions
68 lines (47 loc) · 3.11 KB
/
README.Rmd
File metadata and controls
68 lines (47 loc) · 3.11 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include=FALSE}
knitr::opts_chunk$set(collapse = TRUE, comment = "#>",
fig.path = "man/figures/README-", out.width = "100%")
```
# 'SciViews::R' - Read and Write Data in Different Formats <a href="https://www.sciviews.org/data.io"><img src="man/figures/logo.png" align="right" height="138" /></a>
<!-- badges: start -->
[](https://github.com/SciViews/data.io/actions/workflows/R-CMD-check.yaml)
[](https://codecov.io/gh/SciViews/data.io)
[](https://cran.r-project.org/package=data.io)
[](https://sciviews.r-universe.dev/data.io)
[](https://opensource.org/licenses/MIT)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
<!-- badges: end -->
{data.io} main functions are `read()` and `write()`. They are made super-easy to import and export data in various formats in an unified way (they use functions from other packages under the hood like {haven}, {readr}, {readxl}, {writexl} ...). They care about metadata, in particular, meaningful labels and units for the variables. Also, a mechanism to preprocess data sets using sidecar files, and to translate them into various languages are provided for a subset of R packages data sets.
## Installation
{data.io} is not available from CRAN yet. You should install it from the [SciViews R-Universe](https://sciviews.r-universe.dev). To install this package and its dependencies, run the following command in R:
```{r, eval=FALSE}
install.packages('data.io', repos = c('https://sciviews.r-universe.dev',
'https://cloud.r-project.org'))
```
You can also install the latest development version. Make sure you have the {remotes} R package installed:
``` r
install.packages("remotes")
```
Use `install_github()` to install the {data.io} package from Github (source from **main** branch will be recompiled on your machine):
``` r
remotes::install_github("SciViews/data.io")
```
R should install all required dependencies automatically, and then it should compile and install {data.io}.
## Further explore {data.io}
You can get further help about this package this way. Make the {data.io} package available in your R session:
``` r
library("data.io")
```
Get help about this package:
``` r
library(help = "data.io")
help("data.io-package")
vignette("data-io") # None is installed with install_github()
```
For further instructions, please, refer to these help pages at <https://www.sciviews.org/data.io/>.
## Code of Conduct
Please note that the {data.io} package is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.