-
Notifications
You must be signed in to change notification settings - Fork 4
/
README.Rmd
76 lines (53 loc) · 3.46 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# hansard: Accessing Westminster Parliament Data
<!-- badges: start -->
[](https://opensource.org/licenses/MIT)
[](https://cran.r-project.org/package=hansard)
[](https://github.com/evanodell/hansard)
[](https://cran.r-project.org/package=hansard)
[](https://zenodo.org/badge/latestdoi/72111315)
[](https://github.com/EvanOdell/hansard/actions)
[](https://codecov.io/gh/EvanOdell/hansard?branch=master)
[](https://github.com/EvanOdell/hansard/actions)
[](https://ci.appveyor.com/project/EvanOdell/hansard)
<!-- badges: end -->
An R package to automatically fetch data from the UK Parliament API. Ironically, Hansard data (as in speeches) is not yet accessible through the API. To explore all available data see <http://www.data.parliament.uk/>. Documentation for the API itself is available [here](http://explore.data.parliament.uk/).
Like the UK parliament API, this package is a work in progress. Additional functionalities will be added to the package as they are developed in the API. The most up-to-date documentation for this package will always be available at <https://docs.evanodell.com/hansard/>.
To install from CRAN run:
```
install.packages("hansard")
```
To install the development version run:
```
#install.packages("remotes")
remotes::install_github("evanodell/hansard")
```
## Using hansard
For an introduction to `hansard`, please see the [vignette](https://docs.evanodell.com/hansard/articles/introduction.html).
## Citing hansard
Please cite this package as:
Odell E (2017). _hansard: Provides Easy Downloading Capabilities for the UK Parliament API_. doi: [10.5281/zenodo.591264](https://doi.org/10.5281/zenodo.591264), R package version `r packageVersion("hansard")`, URL: https://cran.r-project.org/package=hansard.
A BibTeX entry for LaTeX users is
```
@Manual{,
title = {{hansard}: Provides Easy Downloading Capabilities for the UK Parliament API},
author = {Evan Odell},
note = {R package version `r packageVersion("hansard")`},
doi = {10.5281/zenodo.591264},
url = {https://cran.r-project.org/package=hansard},
}
```
### Disclaimer
This package is in no way officially related to or endorsed by the UK Parliamentary Data Service. It is released under an MIT license. Please note that this project is released with a [Contributor Code of Conduct](https://github.com/evanodell/hansard/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
Data obtained through the `hansard` package is licensed under the Open Government License. The code in `hansard` uses the MIT license.