2016-09-23 7 views
2

名前空間用のRStudio & devtoolsのヘルプでパッケージを作成しました。説明:&マニュアルページのRoxygen2。これは正常に機能し、最近追加したヘルプページも機能しました。私は著者の名前、電子メール、およびいくつかの詳細を追加することにしました。最初は手動で、その後document()R githubパッケージw/devtools:警告不明のマクロ ' item'

でRMファイルへの変更をプッシュするRスクリプトRoxygen2部品&を編集しかし、manページファイル(BAD)を編集して:私のパッケージ私がインストールすると、以下の

devtools::install_github('SimonDedman/gbm.auto') 

私が手警告:

Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:35: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:37: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:39: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:41: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:43: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:45: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:47: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:49: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:51: unexpected section header '\value' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:55: unexpected section header '\description' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:65: unexpected section header '\examples' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:69: unexpected END_OF_INPUT ' 
' 

これらの項目は、私が変更していない、よく見えて、以前に働いていた単純な@param引数です。 Ditto value//examples引数はすべて標準です(ただし、アップストリームの問題が修正された後に解決される可能性があります)。

これを引き起こす原因は誰でも考えられますか?私のヘルプページは今でもクリック可能ですが、この問題が1つのスクリプト(gbm.valuemap.R)にあっても他のものは問題ないはずです。

ありがとうございます。

+0

'がでのみ有効です「環境」を項目化する。あなたのドキュメントは、\ itemが '\ itemize {\ item hi \ item bye}'または '\ enumerate {\ item hi \ item bye' '内にのみ表示されるようなものですか? '\ value'、' \ description'、 '\ examples'は' @ value'、 '@ description'、' @ examples'でなければなりません。これに関する詳細は、 'roxygen2'ガイドを参照してください。 – Chrisss

+0

RStudioを使用して問題のある.Rdファイルを開いてプレビューする方法はありますか?以前の作業バージョンを使用している場合は、.Rdの2つのバージョンの違いを比較することもできます。別の野生の推測は、手作業でファイルを編集した場合、気づかないエンコーディング/行末の変更がある可能性があります。 – dracodoc

+1

完全にはわかりませんが、「読み込み(例)read.csvで指定してください」などの行には '&'が表示されることがあります。私は句読点のいくつか、特に '%'が問題であることを思い出しています。 '&'を 'と'に変更することは価値があるかもしれません。 – Benjamin

答えて

2

あなたはいくつかの局面では、パッケージの開発に役立つようにRStudioを使用することができます。

  1. 使用パッケージプロジェクトのビルドパネルで&負荷ツールを構築します。ドキュメントを作成、更新することができます(Roxygen2の設定でさらにオプションをチェックすることができますが、デフォルトではオンになっていないものもあります)。ワンクリックでパッケージを読み込みます。あなたが直面したエラーは、以前に見つかったはずであり、手動でインストールしてテストする必要はありません。 .Rdは、もう一つの方法は、違いを見つけるために、労働と非作業バージョンのソースファイル、.Rdファイルを比較することである

を提出するために

  • は、プレビュー機能を使用します。

    一般に、生成されたファイルの直接編集は避けるべきです。ここでは、この答えは、より完全なものにするに

    はRdファイルの書式について@Benjaminからのヒントがあります:

    を「とのインポート(例えば)&指定read.csv」のようにそれはラインで&かもしれ私は完全にはわかりませんが。 という問題のある句読点のうち、特に%が覚えています。 @Thomasからショット

    をする&を変更し、価値があるかもしれません:

    あなたが浮遊している場合も出てくることができます{どこかitem` \

  • +0

    ありがとうございます。誰でもこの問題を抱えている人は、@Thomasのメモで迷惑な中括弧 –

    関連する問題