パッケージを作る３

• このファイルに手順をまとめてみた
• Sweave() Rの実行コマンドつきの文書を処理してTEXファイルを作る関数
  • これを使って、Rパッケージの解説文書を作ろう、という記事はある
  • 逆に、Sweave()関数用文書を作り、その実行（TEX文書化)をし、引き続いて、パッケージも作成しようというやり方をしてみる
• .Rnwファイル(Sweave()関数用のファイル)の作成
  • これがサンプル("sample.Rmw")
• Sweave()で処理してできた
  • Texファイル
  • PDFファイル
• package.skeleton()で処理してできたパッケージ関係ファイル
  • DESCRIPTIONファイル
  • Read-and-delete-me ファイル
• manディレクトリ以下のファイル
  • samplePkg-package.Rd ファイル(パッケージ全体の説明ファイル)
    • 以下のように書き換えた(修正後のファイル)
      • 修正前

\title{
What the package does (short line)
~~ package title ~~
}
...
\examples{
~~ simple examples of the most important functions ~~
}

• • • • 修正後

\title{samplePkg
What the package does (short line)
~~ package title ~~
}
...
\examples{
myFx1()
%~~ simple examples of the most important functions ~~
}

• • myFx1.Rdファイル
    • 以下のように書き換えた(修正後のファイル)
      • 修正前

\title{
%%  ~~function to do ... ~~
}
...
\examples{
##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--	or do  help(data=index)  for the standard data sets.

## The function is currently defined as
function (n = 1000) 
{
    sort(runif(n))
  }
}

• • • • 修正後

\title{myFx1
%%  ~~function to do ... ~~
}

...
\examples{
##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--	or do  help(data=index)  for the standard data sets.

## The function is currently defined as
function (n = 1000) 
{
    sort(runif(n))
  }
}
myFx1()

• • myFx2.Rdファイル
    • 以下のように書き換えた(修正後のファイル)
      • 修正前

\title{
%%  ~~function to do ... ~~
}
...
\examples{
##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--	or do  help(data=index)  for the standard data sets.

## The function is currently defined as
function (n1 = 1000, n2 = 1000) 
{
    d <- rep(0, n2)
    for (i in 1:n2) {
        d[i] <- myFx1(n1)[1]
    }
    d
  }
}

• • • • 修正後

\title{myFx2
%%  ~~function to do ... ~~
}

...
\examples{
##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--	or do  help(data=index)  for the standard data sets.

## The function is currently defined as
function (n1 = 1000, n2 = 1000) 
{
    d <- rep(0, n2)
    for (i in 1:n2) {
        d[i] <- myFx1(n1)[1]
    }
    d
  }
}
myFx2()

• • d1.Rd ファイル
    • 以下のように書き換えた(修正後のファイル)
      • 修正前

\title{
%%   ~~ data name/kind ... ~~
}

...
\examples{
data(d1)
## maybe str(d1) ; plot(d1) ...
}

• • • • 修正後

\title{d1
%%   ~~ data name/kind ... ~~
}

...
\examples{
data(d1)
plot(d1)
## maybe str(d1) ; plot(d1) ...
}

• • d2.Rd ファイル
    • 以下のように書き換えた(修正後のファイル)
      • 修正前

\title{
%%   ~~ data name/kind ... ~~
}

...
\examples{
data(d1)
## maybe str(d1) ; plot(d1) ...
}

• • • • 修正後

\title{d1
%%   ~~ data name/kind ... ~~
}

...
\examples{
data(d1)
plot(d1)
## maybe str(d1) ; plot(d1) ...
}

• Rディレクトリ以下のファイル
  • myFx1.R 定義関数ファイル
  • myFx2.R 定義関数ファイル
  • samplePkg-internal.R 多分無くてもよいファイル(疑似乱数の種)
• dataディレクトリ以下のファイル(バイナリファイル)
  • d1.rda ファイル
  • d2.rda ファイル