r - 功能注释未显示在 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 中只运行单个“块”时，它打印了包含注释的函数，所以我认为它一定与 IDE 默认句柄 knitr 有关。

Answer 1

这不是问题 针织 或您使用它的方式或您使用的块选项。

问题是由于 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当包裹是已安装 让它有任何效果。见 ?options有关此的更多详细信息。