2011-08-08 49 views
7

Roxygen使我的工作變得更加輕鬆,並且在大多數情況下都非常直觀。我從來沒有想通了,但有一件事是如何保持在@examples部分縮進,使含在示例部分保留縮進部分

roxygenize("myPackage")結果
#' @examples 
#' sapply(1:10, function(i){ 
#'  x <- rbind(matrix(rnorm(20), 10, 2), 
#'    matrix(rnorm(20), 10, 2) + i) 
#'  myFunc(x) 
#' } 

\examples{sapply(1:10, function(i){ 
    x <- rbind(matrix(rnorm(20), 10, 2), 
       matrix(rnorm(20), 10, 2) + i) 
    myFunc(x) 
}} 

,而不是

\examples{sapply(1:10, function(i){ 
x <- rbind(matrix(rnorm(20), 10, 2), 
matrix(rnorm(20), 10, 2) + i) 
myFunc(x) 
}} 

這是一個小細節,但它使得所有最簡單的例子都不必要難以閱讀,所以如果有人能幫助我,我會很感激。

編輯:此錯誤已在更新版本的roxygen中得到糾正。

+0

你在使用'roxygen'還是'roxygen2'?我很確定這在roxygen2中不會發生,如果它確實是一個錯誤,並且應該報告。 – hadley

+0

我使用的是普通的'roxygen',但問題在我更新爲'roxygen2'後仍然存在。 gsk3的解決方案適用於這兩種,但我想最好還是報道。我怎麼做? – Backlin

+0

請在https://github.com/klutometis/roxygen/issues上提交可複製的錯誤報告 – hadley

回答

4

對於簡短的例子來說可能是太多開銷,但對於更長的例子,您可以@example relative/path/to/example來拉入文件,這應該得到縮進權。

+0

謝謝,它的作品就像一個魅力!開銷並不是很差,因爲它只適用於一些偶然的例子,特別是與手動校正縮進的巨大負擔相比時。 – Backlin