-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathREADME.Rmd
117 lines (71 loc) · 5.62 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
108
109
110
111
112
113
114
115
116
117
---
output: github_document
always_allow_html: true
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
## Real-time and Archives of Taiwan Legislative Data in R <img src="man/figures/logo.png" align="right" width="180"/>
<!-- badges: start -->
[](https://codecov.io/gh/davidycliao/legisTaiwan)
[](https://github.com/davidycliao/legisTaiwan/actions/workflows/R-CMD-check.yaml)
[](https://github.com/davidycliao/legisTaiwan/actions/workflows/test-coverage.yaml)
[](https://github.com/davidycliao/legisTaiwan/actions/workflows/pkgdown.yaml)
[](https://www.codefactor.io/repository/github/davidycliao/legistaiwan)
[](https://doi.org/10.5281/zenodo.7633962)
<!-- badges: end -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
out.width = "100%"
)
```
<!-- <div style="text-align: justify"> -->
<!-- `legisTaiwan` is designed to streamline access to real-time archives of Taiwan's legislative data, drawing inspiration from the UK's TheyWorkForYou API. By providing straightforward access to the Taiwan Legislative Yuan API in R, this package not only aims to enhance legislative accountability and public transparency but also serves as a powerful tool for academic research. Scholars can easily retrieve and analyze legislative data including voting records, parliamentary questions, and bill proposals, facilitating quantitative research and empirical analysis. As the package interfaces directly with Legislative Yuan API endpoints, a stable internet connection is required. Users are welcome to contact [the author](https://davidycliao.github.io) for any API implementation assistance. -->
<!-- </div> -->
<div style="text-align: justify; font-size: 1.1rem; line-height: 1.6; color: #333; max-width: 800px; margin: 1rem auto; padding: 0 1rem; font-family: 'Helvetica Neue', Arial, sans-serif;">
`legisTaiwan` is designed to streamline access to real-time archives of Taiwan's legislative data, drawing inspiration from the UK's TheyWorkForYou API. By providing straightforward access to the Taiwan Legislative Yuan API in R, this package not only aims to enhance legislative accountability and public transparency but also serves as a powerful tool for academic research. Scholars can easily retrieve and analyze legislative data including voting records, parliamentary questions, and bill proposals, facilitating quantitative research and empirical analysis. As the package interfaces directly with Legislative Yuan API endpoints, a stable internet connection is required. Users are welcome to contact <a href="https://davidycliao.github.io" style="color: #3498db; text-decoration: none; border-bottom: 1px solid #3498db;">the author</a> for any API implementation assistance.
</div>
<div style="text-align: justify; font-size: 0.95rem; line-height: 1.6; color: #333; max-width: 800px; margin: 1rem auto; padding: 0 1rem; font-family: 'Helvetica Neue', Arial, sans-serif;">
`legisTaiwan` 套件旨在簡化台灣立法院資料的即時存取，其設計理念來自於英國的 [`TheyWorkForYou API`](https://www.theyworkforyou.com/api/)。透過在 R 環境中提供直接連接立法院開放資料 API 的便捷管道，本套件不僅致力於提升立法問責制和公共透明度，更為學術研究者提供了系統化分析立法數據的工具。研究人員可以輕鬆獲取並分析立法委員的表決紀錄、問政質詢、法案提案等資料，有助於量化研究和實證分析。由於套件需要直接與立法院 API 介接，使用時請確保網路連線穩定。如有任何 API 使用上的問題，歡迎與套件<a href="https://davidycliao.github.io" style="color: #3498db; text-decoration: none; border-bottom: 1px solid #3498db;">我們</a>聯繫。
</div>
<br>
### Get Started with Using [`remotes`](https://github.com/r-lib/remotes):
``` r
install.packages("remotes")
remotes::install_github("davidycliao/legisTaiwan", force = TRUE)
```
```
library(legisTaiwan)
#> ## legisTaiwan ##
#> ## An R package connecting to the Taiwan Legislative API. ##
```
### Summary Descriptive of Taiwan Legilative Yuan API
```{r include=FALSE}
library(legisTaiwan)
```
```{r include=FALSE}
stats <- get_tly_stat()
```
__Legislative Bills Statistics__
```{r}
analyze_bills(stats)
```
__Legislative Meeting Statistics__
```{r}
analyze_meetings(stats)
```
__Legislative Video (IVOD) Statistics__
```{r}
analyze_ivod(stats)
```
<!-- ```{r include=FALSE} -->
<!-- create_interactive_plot(stats) -->
<!-- ``` -->
<br>
### Notice: API Migration
<div style="text-align: justify; font-size: 1.1rem; line-height: 1.6; color: #333; max-width: 800px; margin: 1rem auto; padding: 0 1rem; font-family: 'Helvetica Neue', Arial, sans-serif;">
The Legislative Yuan API has transitioned from `https://ly.govapi.tw` to `https://v2.ly.govapi.tw`. While we are still supporting functions that use the legacy API, please note that according to official notice, the old API endpoint will not be maintained. We recommend users to gradually transition to [the newer functions]() attached with API V2.
</div>
<br>