有条件地在 R Markdown 中显示一个文本块

Question

我正在使用 knitr 解析 R Markdown 文档。有没有办法根据我传递给 knitr 的环境中的变量有条件地在 R Markdown 中显示一段文本？

比如：

`r if(show.text) {`
  la la la
`r }`

如果show.text 为真，将在结果文档中打印“la la la”。

Answer 1

你需要一个完整的 R 表达式，所以你不能像你展示的那样把它分成多个块，但是如果一个块的结果是一个文本字符串，那么它将按原样包含（不带引号），所以你应该能够做类似的事情：

`r if(show.text){"la la la"}`

当且仅当show.text 是TRUE 时它才会包含文本。

Answer 2

您可以使用“eval”块选项来执行此操作。见http://yihui.name/knitr/options/。

```{r setup, echo=FALSE}
show_text <- FALSE
````

```{r conditional_block, eval=show_text}
print("this will only print when show.text is TRUE")
```

我一直在使用YAML 配置文件来参数化我的降价报告，这使得它们更易于重用。

```{r load_config}
library(yaml)
config <- yaml.load_file("config.yaml")
```

...

```{r conditional_print, eval=config$show_text}
print("la la la")
````

Answer 3

我发现最简单的方法是将我的所有文本放入一个单独的文件中，然后将其从主文件中包含：

```{r conditional_print, child='text.Rmd', eval = show_text}
```

这样做的好处是您仍然可以将内联 R 语句或其他块放入子文件中，因此，如果您改变了关于什么是可选文本的想法，则不必重构您的项目。

Answer 4

这是对 Paul Boardman 方法的调整，可在输出中提供适当的标记。

```{r setup, echo=FALSE}
show_text <- FALSE
```

```{r conditional_block, echo=FALSE, results='asis', eval=show_text}
cat("## Hey look, a heading!

lorem ipsum dolor emet...")
```

更好的是，如果我们调用 python 引擎来生成我们的输出，我们可以使用三引号来轻松处理包含单引号或双引号的文本，而无需做任何花哨的事情：

```{python, conditional_block_py, echo=FALSE, results='asis', eval=show_cond_text}
print("""
## Still a heading

Block of text with 'single quotes' and "double quotes"
""")
```

Answer 5

对于较大的文本块，上述解决方案可能有点笨拙，在某些情况下不是很好。假设我想为有一些问题的学生创建一个工作表，并使用相同的 .Rmd 文件生成一个包含解决方案的文件。我使用了基本的 LaTeX 流控制：

``` {r, include = F}
# this can be e.g., in a parent .Rmd and the below can be in child
solution <- TRUE 
```
\newif\ifsol
\sol`r ifelse(solution, 'true', 'false')`

那我可以做：

What is $2 + 2$

\ifsol
4
\fi

这样您还可以使用

创建替代文本块

\ifsol
Alternative 1
\else
Alternative 2
\fi

Answer 6

上面接受的答案适用于内联内容。

对于块内容（Markdown 文本的几个段落之一），knitr 包含一个asis 引擎，允许根据块选项echo = FALSE 或echo = TRUE 有条件地包含Markdown 内容

来自文档https://bookdown.org/yihui/rmarkdown-cookbook/eng-asis.html的示例

```{r}
getRandomNumber <- function() {
  sample(1:6, 1)
}
```

```{asis, echo = getRandomNumber() == 4}
According to https://xkcd.com/221/, we just generated
a **true** random number!
```

如果您需要包含更复杂的内容，例如带有代码块的 R Markdown 文档，那么子文档可能会很有用。见https://bookdown.org/yihui/rmarkdown-cookbook/child-document.html

Answer 7

另一种有条件地添加降价文本的方法如下。它使用block“引擎”，虽然我不确定如何使内联 R 评估工作，但它似乎运行良好。

请注意，我使用 YAML 元数据中定义的 view_all 开关来控制块是否可见。

另外，请注意eval 和include 块选项都是必需的。 第一个防止在 RStudio 中的常规 Run All 期间出现错误。 第二个阻止了 Knit 的输出。

---
title: "Conditional Output"
params:
  view_all: false
output:
  html_document: default
  pdf_document: default
---

```{block eval=FALSE, include=params$view_all}
# Some simple markdown.

Some things work: $2 + 2^2 = 3\cdot2$

Other does not: 2 + 2 = `r 2+2`
```

Answer 8

我尝试定义一个函数my.render()，它预处理Rmd 文件，并根据commentout 参数，将HTML 注释代码(TRUE) 保留在Rmd 文件中或删除它们(FALSE ）。然后将预处理后的Rmd文件写入tmp.Rmd，并使用常用的render()函数。

my.render <- function(input, commentout=FALSE, ...) {
  if (commentout == FALSE) {
    ## Delete the HTML comment lines from code
    txt <- readLines(input)
    txt[grepl(" *<!-- *| *--> *", txt)] <- ""
    write.table(txt, file="tmp.Rmd", sep="\n", quote=FALSE, row.names=FALSE, col.names=FALSE)
    render("tmp.Rmd", output_file=sub("Rmd","html",input), ...)
  } else {
    render(input, output_file=sub("Rmd","html",input), ...)
  }
}

这似乎奏效了。例如

<!--
This text with formulas $\alpha+\beta$ is visible, when commentout=FALSE.
-->