作成の方法〜Rの自分用関数をGithub公開型パッケージにする

  • Rのパッケージは、「インストール」という手続きを踏んで使うことになるので、その「インストール手続き」に合致したファイル構成を作る必要がある
  • その構成と必要ファイルとをぱぱっと作ってくれるのが、devtoolsパッケージとroxygene2パッケージとが提供するcreate()関数とdocument()関数
  • 適当な作業ディレクトリで作業を開始する
  • Rryamadaなる名称のパッケージを作るので
create("Rryamada")
  • とする。そうすると、必要なディレクトリ構成ができる
  • 次にR関数を書いたファイルを作り、作られたディレクトリ構成の中の"R"ディレクトリに納める
  • ただし、このRファイルには、適当な説明ヘッダをつける必要がある
  • なぜなら、その説明ヘッダを読み取って、パッケージに必要なR関数の説明文書をdocument()関数に作ってもらうからである
  • 以下のような書式である
#' A Sample Function
#'
#' This is a toy function
#' @param n is integer for number of randam values.
#' @keywords toy
#' @export
#' @examples
#' n <- 100
#' ry_sample_fx(n)

ry_sample_fx <- function(n){
	plot(rnorm(n))
}
  • このファイルをry_sample_fx.Rという名前にして Rディレクトリに置き、
document()
  • というコマンドを発行すれば出来上がり(エラーが出たら、最低限の条件をクリアしていないということなので、エラーメッセージに応じて対処する
  • 次はこれをgithubに上げる作業
  • githubで新規レポジトリを作る。Rryamadaという名前で作る。
  • からっぽで作るので、README.mdも作らない、という条件で作ろう。
  • そうすると、「そんな空っぽで作らないでください、以下のいくつかの方法の一つでおねがいしますよ」という画面に移動するので、そのうちの一つのやり方にそって作る
  • ローカルPCで、パッケージのトップディレクトリに居る状態で以下のコマンドを発行する
echo "# test" >> README.md
git init
git add README.md
git commit -m "first commit"
git remote add origin https://github.com/ryamada22/test.git
git push -u origin master
  • すると、ローカルのディレクトリが、githubのレポジトリとgitコマンドでつながった関係になるとともに、README.mdファイルが作成される
  • パッケージ諸ファイルのアップロード(push)の準備ができたので、さらに次のコマンドを発行する
    • 第1行は「すべて=.」をgitする対象に加える、という意味
    • 第2行は、その処理に付与する「コメント」
    • 第3表は、「アップロード=push」
git add .
git commit -m 'initial  package '
git push