住所や年号、漢数字のデータ操作を楽にするRパッケージをCRANに登録しました
副題「失われた『Nippon』を求めて」（仰々しい）。
NipponパッケージというRパッケージがあります。 このパッケージは、日本人が頻繁に遭遇するであろう、全角英数字や元号の変換、祝日の判定といった処理を効率的に行うための関数や日本の都道府県名を含んだデータセットを提供していました。
いました、と過去形にするのは今年(2019年)の7月にCRANからアーカイブされてしまったためです。現在は install.packages("Nippon") を実行してもインストールできません。
Nipponパッケージは当然日本人の利用者も数多く、日本人Rユーザが集うSlack、r-wakalang上でも「なぜアーカイブされたのか」「今後はどうなるのか」というやり取りもありました。 パッケージがCRANから除外されてしまった経緯はさておき、このパッケージの関数は私自身も重宝していたのでなんとかしたいという気持ちでいました。 そして今回、Nipponパッケージの代替え、そしてより便利な機能を提供することを目指して、新たにzipanguという名前のパッケージをCRANに登録しました。
とりあえずCRANからインストールできる状態を目標にしていたため、まだ使える機能は限定的ですが各関数の使い方を解説します。 まずはパッケージを利用するために、パッケージのインストールを行います。
install.packages("zipangu") # v.0.1.0 library(zipangu)
zipanguパッケージの関数
Address: 住所文字列の要素分割
与えられた住所文字列をその要素、すなわち都道府県、市区町村、それ以下の住所に分割、リストとして返却します。
separate_address("東京都千代田区大手町一丁目") #> $prefecture #> [1] "東京都" #> #> $city #> [1] "千代田区" #> #> $street #> [1] "大手町一丁目" separate_address("北海道余市郡余市町朝日町") #> $prefecture #> [1] "北海道" #> #> $city #> [1] "余市郡余市町" #> #> $street #> [1] "朝日町" separate_address("宮城県柴田郡村田町大字村田") #> $prefecture #> [1] "宮城県" #> #> $city #> [1] "柴田郡村田町" #> #> $street #> [1] "大字村田"
住所の一部が与えられた時は、欠損する要素をNAとして処理します。
separate_address("岡山市") #> $prefecture #> [1] NA #> #> $city #> [1] "岡山市" #> #> $street #> [1] NA separate_address("奈良県高市郡高取町") #> $prefecture #> [1] "奈良県" #> #> $city #> [1] "高市郡高取町" #> #> $street #> [1] NA
ソースコードを見たらわかるのですが、力づくでの正規表現によるパターンマッチで実装しているのでもっとスマートに書ける気がしています。
Year: 元号が使われる年表記を西暦に変換
convert_jyear()関数で「平成元年」や「昭和52年」、「T5」(大正5年)といった元号を用いた年表記を西暦での表記に変換します。Nipponパッケージが対応していなかった「令和」にも対応しています。
convert_jyear("平成元年") #> [1] 1989 convert_jyear(c("R1", "昭和52年")) #> [1] 2019 1977
この処理の逆、西暦から元号へは対応していません。次のバージョンでの課題です。
Kansuji: 漢数字をアラビア数字に変換
デフォルトでは変換したアラビア数字は文字列型として処理されますが、数値として返却させるなど、いくつかのオプションがあります。
kansuji2arabic(c("一", "百")) #> [1] "1" "100" # 返り値を数値にします kansuji2arabic(c("一", "百"), convert = FALSE) #> [1] 1 100 # .under = で指定した値未満の漢数字だけを対象とします kansuji2arabic(c("一", "百", "千"), .under = 1000) #> [1] "1" "100" "千"
住所のように、文字列中のすべての漢数字をアラビア数字に変えるには kansuji2arabic_all()が利用できます。
kansuji2arabic_all("北海道札幌市中央区北一条西二丁目") #> [1] "北海道札幌市中央区北1条西2丁目"
str_jconv: 全角・半角、ユニコード正規化
この関数はCRAN登録のv0.1.0では利用できません。
Nipponパッケージではzen2han()、han2zen()、kata2hira()、hira2kata()といった関数で全角文字列を半角にしたり、片仮名と平仮名の変換を行える関数がありました。
zipanguでも以下の関数を用意する予定です。
str_conv_hirakana("アイウエオ", to = "hiragana") #> [1] "あいうえお" str_conv_hirakana("あいうえお", to = "katakana") #> [1] "アイウエオ"
str_conv_zenhan("ａ０", "hankaku") #> [1] "a0" str_conv_zenhan("ｶﾞｯ", "zenkaku") #> [1] "ガッ"
また、Nipponにはなかったユニコード正規化のための関数も実装予定です。
str_conv_normalize("①②③", "nfkc") #> [1] "123"
祝日の判定
この関数はzipangu v0.1.0では未実装です。
Nippon::is.jholiday()として提供されていたものです。日付オブジェクトを与えると、その日が祝日かどうかを返却する関数です。
Nippon::is.jholiday(as.Date("2019-11-03")) #> [1] TRUE # 天皇誕生日の変更についてはサポートされていない Nippon::is.jholiday(as.Date("2019-12-23")) #> [1] TRUE
祝日のリストから対応する日付を判定させれば良いのですが、今年のようにイレギュラーな祝日が入ったりすることまでサポートしようとすると実装は大変そうです。
Nipponパッケージを使いたい
まだ未実装の関数もあり、アーカイブされたとはいえNipponパッケージを使いたい方は、下記のコードを実行することでNipponパッケージが利用可能になります。
remotes::install_github("cran/Nippon")
開発に協力してください
最後にお願いです。
NipponパッケージのソースコードはGitHub等で公開されてはいませんでした。 機能改善やバグ報告は受け付けていましたが、メールでのやり取りに敷居の高さを感じていた方もいたのではないでしょうか。
zipanguパッケージは多くのRパッケージ同様、オープンソースで開発、ソースコードをGitHub上で公開しています。 問題の報告や改善点の要望もGitHubのissueで受け付けています。 これらは誰でもできるので、今更言うほどでもないのですが、このパッケージの開発ならびに保守を手伝ってくれる方を募集しています。
これは私自身が、いつまでこのパッケージをメンテナンスし続けられるのかわからないためであります。 コラボレータがいることで、このパッケージがNipponと同じ轍を踏むリスクを低下させられるのではと考えています。
コラボレータを募る背景には、日本人のRパッケージ開発者を養成したいと言う気持ちがあるのですが、これについては別の記事を書くつもりです。
日本語データの処理でよく使う機能がある方はぜひお願いします。 Rのパッケージ開発についてはわからない...そんな場合でも、パッケージの作成方法についていくらか教えることができますので、遠慮なく手を挙げていただければ幸いです。
まだ小さなパッケージですが、どうぞよろしくお願いします。
