-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
87 lines (61 loc) · 3.89 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
---
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%"
)
devtools::load_all()
```
# jpaccidents <a href="https://nononoexe.github.io/jpaccidents/"><img src="man/figures/logo.png" align="right" height="138" alt="jpaccidents website" /></a>
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://CRAN.R-project.org/package=jpaccidents)
[](https://github.com/NONONOexe/jpaccidents/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/NONONOexe/jpaccidents)
<!-- badges: end -->
jpaccidents is package for handling the traffic accident data in Japan.
This package covers the traffic accident data provided by the [National Police Agency of Japan](https://www.npa.go.jp/english/index.html).
> jpaccidentsは日本の交通事故のデータを扱うためのパッケージです。
> このパッケージでは、[警察庁](https://www.npa.go.jp/index.html)が提供する交通事故データを対象としています。
## Installation
You can install the development version of jpaccidents like so:
> jpaccidentsの開発版は以下のコマンドからインストールできます。
``` r
install.packages("remotes")
remotes::install_git("https://github.com/NONONOexe/jpaccidents")
```
## Usage
Load the package as follows:
> パッケージを以下のようにして読み込みます。
```{r load_library, eval=FALSE}
library(jpaccidents)
```
The traffic accident data can be used follows:
> 交通事故のデータは次のようにして利用することができます。
```{r download_data, eval=FALSE}
downloaded_path <- download_accident_main_data(download_dir = "download-dir-path", year = 2022)
main_data <- read_accident_main_data(downloaded_path)
```
There are three types of traffic accident data: main (honhyo), sub (hojyuhyo), and highway (kosokuhyo) data.
The package provides functions for each of these.
Use the function appropriate for the data you need.
See also `? download_accident_main_data` for more information.
> 交通事故のデータは本票、補充票、高速票の3種類があります。
> それぞれに対応する関数が用意されています。
> 必要なデータに応じて利用してください。
> 詳しくは`? download_accident_main_data`を参照してください。
## License
This package is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
The traffic accident data downloaded using this package is provided by the National Police Agency of Japan under the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/).
> このパッケージはMITライセンスの下で提供されています。詳細は[LICENSE](LICENSE)ファイルを参照してください。
> また、本パッケージによりダウンロードできる交通事故データは、警察庁により[クリエイティブ・コモンズ 表示 4.0 国際 ライセンス](https://creativecommons.org/licenses/by/4.0/deed.ja)の下で提供されています。
## Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.
> このプロジェクトは[行動規範](CODE_OF_CONDUCT.md)を設けています。
> したがって、このプロジェクトでは参加者にこの行動規範に従うことを求めます。