如何将代码折叠添加到 rmarkdown html 文档中的输出块

How to add code folding to output chunks in rmarkdown html documents

我非常感谢 RMarkdown 中的 "code_folding" 功能。然而,我真正需要的是让代码一直显示并在输出上切换显示。

---
title: "test file"
author: "dayne"
date: "June 10, 2016"
output: 
  html_document:
    code_folding: hide
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```

Here is a basic example.

```{r}
3 + 4
```

有没有办法切换输出而不是代码?我想到的最好(但不理想)的解决方案是将 collapse=TRUE 添加到块中,但代码和输出仍然同时显示。

Link到编译文件:http://rpubs.com/daynefiler/188408

目录:

  1. 完全控制应该折叠哪些块

  2. 折叠所有包含超过一行code/output

  3. 的块

1。完全控制应该折叠哪些块

我也想拥有相同的功能并执行了以下操作:

我创建了一个 JavaScript,如下所示:

$(document).ready(function() {

  $chunks = $('.fold');

  $chunks.each(function () {

    // add button to source code chunks
    if ( $(this).hasClass('s') ) {
      $('pre.r', this).prepend("<div class=\"showopt\">Show Source</div><br style=\"line-height:22px;\"/>");
      $('pre.r', this).children('code').attr('class', 'folded');
    }

    // add button to output chunks
    if ( $(this).hasClass('o') ) {
      $('pre:not(.r)', this).has('code').prepend("<div class=\"showopt\">Show Output</div><br style=\"line-height:22px;\"/>");
      $('pre:not(.r)', this).children('code:not(r)').addClass('folded');

      // add button to plots
      $(this).find('img').wrap('<pre class=\"plot\"></pre>');
      $('pre.plot', this).prepend("<div class=\"showopt\">Show Plot</div><br style=\"line-height:22px;\"/>");
      $('pre.plot', this).children('img').addClass('folded');

    }
  });

  // hide all chunks when document is loaded
  $('.folded').css('display', 'none')

  // function to toggle the visibility
  $('.showopt').click(function() {
    var label = $(this).html();
    if (label.indexOf("Show") >= 0) {
      $(this).html(label.replace("Show", "Hide"));
    } else {
      $(this).html(label.replace("Hide", "Show"));
    }
    $(this).siblings('code, img').slideToggle('fast', 'swing');
  });
});

由于我不是 JS 高手,所以它可能并不完美,但它确实做到了它应该做的。 将其包含在您的 Rmd 文件中:

<script src="js/hideOutput.js"></script>

我还写了一些 CSS 定义来设置按钮的样式:

.showopt {
  background-color: #004c93;
  color: #FFFFFF; 
  width: 100px;
  height: 20px;
  text-align: center;
  vertical-align: middle !important;
  float: right;
  font-family: sans-serif;
  border-radius: 8px;
}

.showopt:hover {
    background-color: #dfe4f2;
    color: #004c93;
}

pre.plot {
  background-color: white !important;
}

在同时包含 JS 文件和样式表之后,您可以通过使用以下 类:

之一将 div 容器包裹在它们周围来隐藏块

仅隐藏输出

<div class="fold o">
```{r}
  ...
```
</div>

隐藏源代码

<div class="fold s">
```{r}
  ...
```
</div>

两者都隐藏

<div class="fold s o">
```{r}
  ...
```
</div>

脚本检测每个块的类型(例如源代码、文本输出或绘图输出)并相应地标记按钮。

结果如下所示:


2。折叠所有包含超过一行 code/output

的块

这是一个脚本版本,它为所有长于一行的块添加了折叠功能:

$(document).ready(function() {
  $plots = $('img.plot');
  $chunks = $('pre').has('code');
  $chunks = $chunks.filter(function(idx) {
    return $(this).children('code').outerHeight(false) > parseInt($(this).css('line-height'));
  });

  $chunks.each(function () {
    if($(this).hasClass('r')) {
      $(this).append("<div class=\"showopt\">Show Source</div><br style=\"line-height:22px;\"/>");
    } else {
      $(this).append("<div class=\"showopt\">Show Output</div><br style=\"line-height:22px;\"/>");
    }
  });

  $plots.each(function () {
    $(this).wrap('<pre class=\"plot\"></pre>');
    $(this).parent('pre.plot').prepend("<div class=\"showopt\">Show Plot</div><br style=\"line-height:22px;\"/>");
  });

  // hide all chunks when document is loaded
  $chunks.children('code').toggle();
  $('pre.plot').children('img').toggle();
  // function to toggle the visibility
  $('.showopt').click(function() {
    var label = $(this).html();
    if (label.indexOf("Show") >= 0) {
      $(this).html(label.replace("Show", "Hide"));
    } else {
      $(this).html(label.replace("Hide", "Show"));
    }
    $(this).siblings('code, img').slideToggle('fast', 'swing');
  });
});

只需将其包含在 <script src="js/hideAll.js"></script> 中,您无需将 div 容器包裹在代码块周围。 不过,您必须在 Rmd 文档中添加的一件事是以下全局块选项:

```{r, echo = F}
knitr::opts_chunk$set(out.extra = 'class="plot"')
```

需要识别图形输出。

我直接从我设置code_folding: show的另一个Rmarkdown文档的源代码中复制了javascript。我将 javascript 保存为 py_code_folding.js 并将 <script src="py_code_folding.js"></script> 添加到我的 Rmarkdown 文档的顶部。唯一的限制是我必须在我的 javascript 中硬编码是否希望块最初显示或隐藏。

window.initializePythonCodeFolding = function(show) {

  // handlers for show-all and hide all
  $("#rmd-show-all-code").click(function() {
    $('div.r-code-collapse').each(function() {
      $(this).collapse('show');
    });
  });
  $("#rmd-hide-all-code").click(function() {
    $('div.r-code-collapse').each(function() {
      $(this).collapse('hide');
    });
  });

  // index for unique code element ids
  var currentIndex = 10000;

  // select all R code blocks
  var rCodeBlocks = $('pre.python');
  rCodeBlocks.each(function() {

    // create a collapsable div to wrap the code in
    var div = $('<div class="collapse r-code-collapse"></div>');
    if (show)
      div.addClass('in');
    var id = 'rcode-643E0F36' + currentIndex++;
    div.attr('id', id);
    $(this).before(div);
    $(this).detach().appendTo(div);

    // add a show code button right above
    var showCodeText = $('<span>' + (show ? 'Hide' : 'Code') + '</span>');
    var showCodeButton = $('<button type="button" class="btn btn-default btn-xs code-folding-btn pull-right"></button>');
    showCodeButton.append(showCodeText);
    showCodeButton
        .attr('data-toggle', 'collapse')
        .attr('data-target', '#' + id)
        .attr('aria-expanded', show)
        .attr('aria-controls', id);

    var buttonRow = $('<div class="row"></div>');
    var buttonCol = $('<div class="col-md-12"></div>');

    buttonCol.append(showCodeButton);
    buttonRow.append(buttonCol);

    div.before(buttonRow);

    // update state of button on show/hide
    div.on('hidden.bs.collapse', function () {
      showCodeText.text('Code');
    });
    div.on('show.bs.collapse', function () {
      showCodeText.text('Hide');
    });
  });

}

$(document).ready(function () {
  window.initializePythonCodeFolding("show" === "show");
});

一种切换部分的快捷方式(不一定是代码):

在您的 .Rmd 文件中包含要使用 <div class="toggle"><button>TOGGLE_TEXT</button><\div> 切换的部分

1. How many users are in the second, but not the first, user table?

    <div class="toggle"><button>Solution</button>
    ```{r}
    setdiff(user2, user) %>% nrow()
    ```
    </div>

将其放在 .Rmd 文件的底部(或者最好放在链接到所有页面的 .js 文件中)。

<script>
  $(".toggle").click(function() {
    $(this).toggleClass("open");
  });
</script>

将其放入您的 .css 文件中(您必须调整按钮的高度)。

.toggle {
  height: 1.55em;
  overflow-y: hidden;
}
.toggle.open {
  height: auto;
}

这个低保真解决方案怎么样?

<details><summary>Click here</summary>
Some text

```{r code}
# even code
print("Hello world!")
```
</details>

不是我的,但我喜欢。