パッケージを作る4

  • このファイルに手順をまとめてみた
  • 手順のおおまかな部分は上のPDFファイルでよいとして・・・いくつかの面倒が・・・
  • "R CMD"コマンドによる処理まで
    • "hoge.Rd"ファイルの修正
      • 関数の説明ファイル"hoge.Rd"は、文字コード制限があるので、アルファベットだけで書いておくのが無難(文字コード指定でクリアできそうな気もするが、方法、わからず)
      • "hoge.Rd"には"examplesが必須だが、そこに"%"があると(たとえば行列の外積の"%*%"が邪魔をする(すくなくともWindowsでファイルを作成しているときには・・・)"\%*\%"とする必要がある
      • 相互参照用の"\seealso{}"で、相互にリンクを張るわけだけれど、そこは"\code{\link{hige}}"と書く(らしい)
  • "R CMD check PKG -no-latex"がコマンド
    • "-no-latex"のオプションは、LINUXlatexが動いていないから
    • 関数ファイル"hoge.R",データオブジェクトファイル"hoge.dat",解説ファイル"hoge.Rd","DESCRIPTION"ファイルなどが適当か、などのチェック。以下の2つをとにかく通すこと
    • "\title{}"
    • "\examples{}"
  • "R CMD build --binary PKG" とLINUX上で打ちます。
    • これで、LINUX用のパッケージが"PKG-hoge-hage.tar.gz"というファイルができます(たぶんMacもこおれでいける???)
  • Windows用にするには、
    • "tar -xvzf PKG-hoge-hage.tar.gz"というコマンドを打ちます。そうすると、先ほど、Linux用に使った、"PKG"ディレクトリの下に、新たなディレクトリとファイルができます。
    • その大きな変化としては、
      • Rdファイルのhtml化文書が"html"ディレクトリ配下にできること
      • さらに、それらのhtml文書は、"00INDEX.html"ファイルによって相互にリンクが張られていて、すべての説明文書への索引探索が可能になります。
      • Rdファイルからできたすべての説明htmlファイルの末尾に、この索引htmlへのリンクが張ってあります
      • それ以外に"Meta"ディレクトリ、"help"ディレクトリができます。
    • その上で、"zip -r PKG.zip PKG"とコマンドをうち、zipにします。
    • これをwindows ローカルにもって来て、「ローカルにあるzipからパッケージをインストール」すると、通常のパッケージと同じで、Rのいつものlibrary置き場に解凍して置かれます
    • この段階で、RのGUIで"library(PKG)"とすれば読み込まれますし、ここから"help(PKG)"とすることで、パッケージ説明htmlが開き、その末尾からIndexへ飛べば、すべての解説文書へのリンクが得られます