メンテナンスガイド • ylistjp

このガイドは、ylistjp を保守するときに「何を直したい場合、どのファイルを見ればよいか」を素早く判断するための開発者向けメモです。

どこを直すか

直したいこと	主に見るファイル
YList のダウンロード URL、キャッシュファイル名、キャッシュ場所	`R/cache.R`
タブ区切り YList ファイルの読み込み方法	`R/load.R`
`academic_name()` の挙動	`R/lookup.R`, `tests/testthat/test-lookup.R`
`ylist_search()` の検索対象やマッチ規則	`R/lookup.R`, `tests/testthat/test-lookup.R`
GBIF API の返却列や挙動	`R/gbif.R`, `tests/testthat/test-gbif.R`
export する関数	`NAMESPACE`, `man/` 以下の対応する `.Rd`
パッケージ情報、依存関係、サイト URL	`DESCRIPTION`
README と pkgdown トップページ	`README.md`
日本語 README	`README.ja.md`
pkgdown のナビゲーションや reference 分類	`_pkgdown.yml`
使い方ガイド	`vignettes/get-started.Rmd`, `vignettes/ja-get-started.Rmd`
メンテナンスガイド	`vignettes/maintenance.Rmd`, `vignettes/ja-maintenance.Rmd`
パッケージ開発チュートリアル	`vignettes/package-development.Rmd`, `vignettes/ja-package-development.Rmd`
R パッケージチェックの GitHub Actions	`.github/workflows/R-CMD-check.yaml`
GitHub Pages / pkgdown deploy	`.github/workflows/pkgdown.yaml`

実装は R/cache.R です。

ここを直す典型例:

返り値は、現在の仕様ではキャッシュ済みファイルパスを invisibly に返します。キャッシュ関連のテストは tests/testthat/test-cache-load.R にあります。

実装は R/load.R です。

ここを直す典型例:

現在は YList の公開タブ区切りファイルを CP932 として読み込んでいます。単体テストでは本番の巨大ファイルを直接ダウンロードせず、小さな合成 fixture で文字コードと列構造を確認します。

実装は R/lookup.R です。

ここを直す典型例:

現在の仕様は保守的です。

この仕様を変えた場合は、README、日英の使い方ガイド、テストも一緒に更新します。

実装は R/lookup.R です。

ここを直す典型例:

検索機能は、候補を人間が確認できるようにするための関数です。 academic_name() を暗黙の fuzzy lookup に変えるより、検索候補を明示的に返す設計を優先します。

実装は R/gbif.R です。

ここを直す典型例:

GBIF の live test は通常 skip されます。ネットワークテストを明示的に走らせる場合は YLISTJP_RUN_NETWORK_TESTS=true を設定します。

pkgdown のトップページは README.md から生成されます。そのため、トップページは英語を正にし、日本語で読みたい人には README.ja.md と日本語ガイドへ誘導します。

役割分担は次の通りです。

ドキュメントを変えた後は、可能なら pkgdown サイトをローカルでビルドします。

pkgdown::build_site(preview = FALSE)

単体テスト:

testthat::test_local(".", reporter = "summary")

パッケージ build/check:

R CMD build .
R CMD check ylistjp_0.1.0.tar.gz --no-manual

Windows で Pandoc が PATH にない場合は、vignettes や pkgdown の build 前に RSTUDIO_PANDOC をインストール済み Pandoc のディレクトリへ向けます。

保守変更を push する前に、次を確認します。