2017-05-08 9 views
2

roxygen2を使用して非ASCII文字(å、ä、öなど)を使用してRでドキュメントを書くことはできますか?私はスウェーデン語の内部機能を持つパッケージを書いているので、私は尋ねています。roxygen2で非ASCII文字を使ってパッケージドキュメントを書くことはできますか?

私は、ドキュメントを書くことroxygenを使用して、次のコードを使用しています

#' @param data data frame där variablen finns 
#' @param x variabeln, måste vara en av typen character 

これは歪んで非ASCII文字になります。私は.Rdファイルを手動で変更することができますが、私はむしろそうしたくありません。

+1

私は、このようなAの '\ rを{A}'(https://en.wikibooks.org/wiki/LaTeX/Special_Characters#Escaped_codes)などのLaTeXマクロを使用することをお勧めするつもりだったが、これらはしていないように見えますR CMD INSTALLによって認識される - これらのマクロを "活性化"するオプションがあるのだろうか? – ms609

答えて

1

非ASCII文字はRhttps://cran.r-project.org/doc/manuals/r-release/R-exts.html#Package-subdirectories)で使用するのが難しいです。

コードファイルでは、ASCII文字(および制御文字タブ、formfeed、LFおよびCR)のみを使用する必要があります。コメント13では他の文字が使用できますが、コメントは例えばUTF-8ロケールパッケージがインストールされると、オブジェクト名のASCII以外の文字は通常14失敗します。すべてのバイトは引用符で囲まれた文字列で許可されますが、\ uxxxxエスケープはASCII以外の文字に使用する必要があります。ただし、非ASCII文字列は一部のロケールでは使用できず、他のロケールでは正しく表示されないことがあります。

説明のために、@encoding UTF-8をroxygen2コードに追加する必要があります。

次のようにして、\uxxxxエスケープがタグで正常に使用されているかどうかを確認できます。

path <- "path to Rd file" 
tools::checkRd(path) 
関連する問題