-
Notifications
You must be signed in to change notification settings - Fork 31
/
README.Rmd
109 lines (73 loc) · 4.24 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
101
102
103
104
105
106
107
---
output: md_document
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
<!-- badges: start -->
[](http://ropengov.org/)
[](https://github.com/rOpenGov/pxweb/actions)
[](https://codecov.io/gh/rOpenGov/pxweb)
[](https://cran.r-project.org/package=pxweb)
[](https://cran.r-project.org/package=pxweb)
[](https://cran.r-project.org/package=pxweb)
[](https://gitter.im/rOpenGov/pxweb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]
[](https://twitter.com/intent/follow?screen_name=ropengov)
[](https://github.com/rOpenGov/pxweb/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
<br>
# R tools to access PX-WEB API - the pxweb R package <a href='https://ropengov.github.io/pxweb/'><img src='man/figures/logo.png' align="right" height="139" /></a>
<!-- README.md is generated from README.Rmd. Please edit that file -->
The pxweb R package provides tools to interface with the PX-WEB API
for data search, download, manipulation and visualization
purposes. This is used by a large number of statistical authorities
world-wide. It offers methods to utilize information about the data
hierarchy stored behind the PXWEB API.
Many API services are still in their early stages, and data quality is
sometimes compromised. Issue reports are welcome.
## Installation
The easiest way to use pxweb is to simply install it from CRAN:
```{r, eval=FALSE}
install.packages("pxweb")
```
Alternatively, you can get the latest stable development version:
```{r, results='hide', message=FALSE, eval=FALSE}
library(remotes)
remotes::install_github("ropengov/pxweb")
```
In some cases, the organization requires manual proxy settings. This can be set as follows:
```{r, results='hide', message=FALSE, eval=FALSE}
library(remotes)
library(httr)
set_config(
use_proxy("64.251.21.73", 8080) # Note! This is an example
)
remotes::install_github("ropengov/pxweb")
```
```{r, results='hide', echo=FALSE}
# This resets the config when the README is tested
httr::reset_config()
```
## Using the package
For examples, check the [tutorial/vignette](https://ropengov.github.io/pxweb/articles/pxweb.html).
## Problems?
See [TROUBLESHOOTING.md](https://github.com/rOpenGov/pxweb/blob/master/TROUBLESHOOTING.md) or [open an issue](https://github.com/ropengov/pxweb/issues).
# Contributing
You are welcome to contact us:
* [Submit suggestions and bug reports](https://github.com/ropengov/pxweb/issues) (provide the output of `sessionInfo()` and `packageVersion("pxweb")`)
* [Send a pull request](https://github.com/ropengov/pxweb)
* [Star us on the Github page](https://github.com/ropengov/pxweb)
* [Join the discussion in Gitter](https://gitter.im/rOpenGov/pxweb)
### Acknowledgements
**Kindly cite this work** as follows: [Måns Magnusson](https://github.com/mansmeg), Markus Kainu, Janne Huovari, and [Leo Lahti](https://github.com/antagomir). Retrieval and analysis of PC Axis data with the pxweb package. R package version `r sessionInfo()$otherPkgs$pxweb$Version`. URL: <https://ropengov.github.io/pxweb/>
We are grateful to all [contributors](https://github.com/rOpenGov/pxweb/graphs/contributors)! This project is part of [rOpenGov](http://ropengov.github.io).
[github-watch-badge]: https://img.shields.io/github/watchers/ropengov/pxweb.svg?style=social
[github-watch]: https://github.com/ropengov/pxweb/watchers
[github-star-badge]: https://img.shields.io/github/stars/ropengov/pxweb.svg?style=social
[github-star]: https://github.com/ropengov/pxweb/stargazers