-
Notifications
You must be signed in to change notification settings - Fork 4
/
README.Rmd
100 lines (72 loc) · 4.45 KB
/
README.Rmd
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
---
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 = "80%"
)
```
<!-- badges: start -->
[](https://ropengov.org/)
[](https://github.com/rOpenGov/sorvi/actions)
[](https://cran.r-project.org/package=sorvi)
[](https://ropengov.r-universe.dev/)
[](https://github.com/badges/stability-badges)
[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]
[](https://twitter.com/intent/follow?screen_name=ropengov)
<!-- badges: end -->
# sorvi<a href="https://ropengov.github.io/sorvi/"><img src="man/figures/logo.png" align="right" height="139" /></a>
sorvi package was originally intended for hosting various algorithms for Finnish open goverment data in [R](https://www.r-project.org). After being superseded by later rOpenGov packages that are more specialized in scope (such as geofi, hetu and pxweb), sorvi has now found a new life in hosting various functions that are helpful in rOpenGov package maintenance, authoring and preparing presentations.
Originally rOpenGov/sorvi was a fork of [juusohaapanen/soRvi-dev](https://github.com/juusohaapanen/soRvi-dev) but rOpenGov's sorvi branch has since taken a life of its own. The fork was detached fron juusohaapanen's branch in November 2021.
## Installation
You can install the development version of sorvi from [GitHub](https://github.com/) with:
```{r, eval = FALSE}
# install.packages("remotes")
remotes::install_github("rOpenGov/sorvi")
```
Development version can be also installed using the
[r-universe](https://ropengov.r-universe.dev):
```{r, eval=FALSE}
# Enable this universe
options(repos = c(
ropengov = "https://ropengov.r-universe.dev",
CRAN = "https://cloud.r-project.org"
))
install.packages("sorvi")
```
There is still a CRAN release version of sorvi and while it passes CRAN checks without problems it contains mostly outdated functions. It is therefore highly recommended to use development version of the package.
## Using the package
Loading the package in R:
```{r example_load, eval=TRUE, message=FALSE}
library(sorvi)
```
Get download statistics of eurostat-package, by year:
```{r example_download_stats, eval=TRUE}
df <- cran_downloads(pkgs = "eurostat", sum = "by_year", use.cache = FALSE)
df
```
Get download statistics of various rOpenGov packages over time and draw a chart:
```{r example_visualize, eval=TRUE}
packages <- c("eurostat", "giscoR", "sotkanet", "geofi", "sweidnumbr")
plot <- cran_downloads(pkgs = packages, sum = "total", output = "plot", use.cache = FALSE)
plot
```
For more examples, check the [package vignette](https://ropengov.github.io/sorvi/articles/sorvi_tutorial.html).
## Contributing
* [Submit suggestions and bug reports](https://github.com/ropengov/sorvi/issues) (provide the output of `sessionInfo()` and `packageVersion("sorvi")` and preferably provide a [reproducible example](http://adv-r.had.co.nz/Reproducibility.html))
* [Send a pull request](https://github.com/ropengov/sorvi/)
* [Star us on the Github page](https://github.com/ropengov/sorvi/)
* [See our website](https://ropengov.org/community/) for additional contact information
## Acknowledgements
**Kindly cite this work** as follows:
[Leo Lahti](https://github.com/antagomir/), Juuso Parkkinen, Joona Lehtomaki and Pyry Kantanen (2023). sorvi: Finnish open data toolkit for R. R package version 0.8.21. URL: https://github.com/rOpenGov/sorvi
We are grateful to Jussi Paananen, Einari Happonen, Juuso Haapanen, and all other [contributors](https://github.com/rOpenGov/sorvi/graphs/contributors)! This project is part of [rOpenGov](https://ropengov.org).
[github-watch-badge]: https://img.shields.io/github/watchers/ropengov/sorvi.svg?style=social
[github-watch]: https://github.com/ropengov/sorvi/watchers
[github-star-badge]: https://img.shields.io/github/stars/ropengov/sorvi.svg?style=social
[github-star]: https://github.com/ropengov/sorvi/stargazers