函数注释未显示在 knitr (r studio) 中

Question

所以我正在制作一个 .rmd 文件来记录我正在构建的一些功能的开发。我在 R 工作室工作。我在输入

时注意到

    ```{r echo=TRUE, tidy=FALSE }
    createExamData
    ```

编织文档中出现了这个

## function (directory) 
## {
##     files = list.files(directory)
##     files = files[grepl("i", files)]
##     files = substring(files[], 1, 4)
##     examData <- LoadData(directory)
##     nExams <- length(examData[[1]])
##     adjMatrixStd <- list(length = nExams)
##     for (i in 1:nExams) {
##         iExam <- examData[[1]][[i]]
##         iExam <- iExam[order(iExam[, 1]), ]
##         gExam <- examData[[2]][[i]]
##         gExam <- gExam[order(gExam[, 1]), ]
##         key <- examData[[3]][[i]]
##         adjMatrixStd <- ComputeStdAdjMatrix(gExam)
##         adjMatrixWt <- ComputeWeightedMatrix(iExam, gExam, key)
##         adjMatrixConv <- calculateConvinceMtd(iExam, gExam)
##         save(iExam, gExam, key, adjMatrixStd, adjMatrixWt, adjMatrixConv, 
##             file = paste(files[i], ".Rdata", sep = ""))
##     }
## }

我已经很好地注释了我的代码，真的不想为我需要显示的每个功能重写我在 markdown 文档中的注释。我的问题是，如果我在 R studio 中制作 Rmarkdown 文件，如何让 knitr 在我的函数中显示我的评论？

我应该提一下，当我在 R studio 中使用运行的选项时，只是个人 'chunk' 它打印了包含注释的函数，所以我认为它一定与 was 有关IDE 默认句柄 knitr.

Answer 1

这不是 knitr 的问题，也不是您使用它的方式，也不是您使用的区块选项。

问题是由于 print.function() 并且它无法访问函数的源代码，而只能访问其已解析的表示形式。

我怀疑这是你加载的包中的函数？如果是这样，一种选择是再次获取该函数的源代码并明确 print() 它。确保 getOptions("keep.source") 是 TRUE.

如果您不想将函数的副本导入工作区，您可以将其导入环境，然后 print 环境中的版本：

env <- attach(NULL, name = "myenv")
sys.source("~/work/git/permute/permute/R/shuffleSet2.R", env,
           keep.source = TRUE)
with(env, print(shuffleSet))

您可能希望 attach 到您包裹下方的搜索路径中的某个位置，以便始终调用包裹代码并且不会给您带来问题。

安装包中代码中没有注释的原因是由于选项keep.source.pkgs，默认为FALSE，当包为[=时需要TRUE 33=]installed 让它有任何效果。有关此内容的更多详细信息，请参阅 ?options。

函数注释未显示在 knitr (r studio) 中

function comments not displaying in knitr (r studio)

r

knitr

r-markdown