README.Rmd

---
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%"
)
```

# zipangu <img src="man/figures/logo.png" align="right" width="120px" />

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html) 
[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/zipangu)](https://cran.r-project.org/package=zipangu)
[![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/zipangu?color=FF5254)](https://cran.r-project.org/package=zipangu) [![minimal R version](https://img.shields.io/badge/R%3E%3D-3.2.0-blue.svg)](https://cran.r-project.org/)

[![Travis build status](https://travis-ci.org/uribo/zipangu.svg?branch=master)](https://travis-ci.org/uribo/zipangu)
[![R build status](https://github.com/uribo/zipangu/workflows/Pkgdown/badge.svg)](https://github.com/uribo/zipangu)
[![Codecov test coverage](https://codecov.io/gh/uribo/zipangu/branch/master/graph/badge.svg)](https://codecov.io/gh/uribo/zipangu?branch=master)
<!-- badges: end -->

The goal of `{zipangu}` is to replace the functionality provided by the `{Nippon}` archived from CRAN. Add some functions to make it easier to treat data that address, year, and Kanji.

## Installation

You can install the released version of `{zipangu}` from CRAN with:

``` r
install.packages("zipangu")
```

and also, the developmment version from GitHub

``` r
install.packages("remotes")
remotes::install_github("uribo/zipangu")
```

## API

```{r}
library(zipangu)
```


### Address

```{r}
separate_address("東京都千代田区大手町一丁目")
```

Applied to data frame.

```{r, warning=FALSE}
library(dplyr, warn.conflicts = FALSE)
data.frame(address = c("東京都千代田区大手町一丁目", "岡山県岡山市北区清心町16-13")) %>% 
  mutate(address_components = purrr::pmap(., ~ separate_address(..1))) %>% 
  tidyr::unnest_wider(col = address_components)
```

### Zip-code

```{r}
read_zipcode(system.file("zipcode_dummy/13TOKYO_oogaki.CSV", package = "zipangu"), "oogaki")
```

You can also load a file directly by specifying a URL.

```{r, eval = FALSE, echo = TRUE}
read_zipcode("https://www.post.japanpost.jp/zipcode/dl/jigyosyo/zip/jigyosyo.zip")
```

Utilities

```{r}
is_zipcode(7000027)
is_zipcode("700-0027")
zipcode_spacer("305-0053")
zipcode_spacer("305-0053", remove = TRUE)

is_prefecture("東京都")
```

### Calendar

#### Year (Japanese imperial year)

```{r}
convert_jyear("R1")
```

### Date

```{r}
convert_jdate("平成元年11月25日")
```

#### Public holidays in Japan

Given a year and holiday name as input, returns the date.

```{r}
jholiday_spec(2021, "New Year's Day", lang = "en")
```
Holiday names can be specified in English ("en") and Japanese ("jp") by default, en is used.

```{r}
jholiday_spec(2021, "Coming of Age Day", lang = "en")
jholiday_spec(2021, "\u6210\u4eba\u306e\u65e5", lang = "jp")
```

Check the list of holidays for a year with the `jholiday()`.

```{r}
jholiday(2021, lang = "jp")
```
Use `is_jholiday()` function to evaluate whether today is a holiday.

```{r}
is_jholiday("2021-01-11")
is_jholiday("2021-02-23")
```

### Convert

#### Hiragana to Katakana and more...

```{r}
str_jconv("アイウエオ", 
          str_conv_hirakana, to = "hiragana")
str_conv_zenhan("ｶﾞｯ", "zenkaku")
str_conv_romanhira("aiueo", "hiragana")
```


#### Kansuji

```{r}
kansuji2arabic(c("一", "百"))
kansuji2arabic_all("北海道札幌市中央区北一条西二丁目")
```

#### Prefecture name

```{r}
harmonize_prefecture_name(
  c("東京都", "北海道", "沖縄県"), 
  to = "short")
harmonize_prefecture_name(
  c("東京", "北海道", "沖縄"), 
  to = "long")
```

### Label

```{r, echo=TRUE, eval=FALSE}
library(scales)
library(ggplot2)
theme_set(theme_bw(base_family = "IPAexGothic"))
demo_continuous(c(1, 1e9), label = label_kansuji())
```

```{r, echo=FALSE, eval=FALSE}
ggsave("man/figures/readme_demo_label_kansuji.png",
       last_plot(),
       width = 6,
       height = 2)
```

![](man/figures/readme_demo_label_kansuji.png)

```{r, eval=FALSE, echo=TRUE}
demo_continuous(c(1, 1e9), label = label_kansuji_suffix())
```

```{r, echo=FALSE, eval=FALSE}
ggsave("man/figures/readme_demo_label_kansuji_suffix.png",
       last_plot(),
       width = 6,
       height = 2)
```

![](man/figures/readme_demo_label_kansuji_suffix.png)

### Data set

```{r}
jpnprefs
```