如何将代码折叠添加到 rmarkdown html 文档中的输出块 [英] How to add code folding to output chunks in rmarkdown html documents
问题描述
我非常欣赏 RMarkdown 中的code_folding"功能.但是，我真正需要的是让代码一直显示并在输出上切换显示.
---标题:测试文件"作者:戴恩"日期:2016 年 6 月 10 日"输出:html_document:代码折叠:隐藏---```{r 设置，包括 = FALSE}knitr::opts_chunk$set(echo = TRUE)``这是一个基本的例子.```{r}3 + 4``有没有办法切换输出而不是代码?我想到的最好(但不理想)的解决方案是将 collapse=TRUE 添加到块中，但是代码和输出仍然同时显示.
编译文档链接:
<小时>2.折叠包含多于一行代码/输出的所有块
这是一个脚本版本，它为所有长度超过一行的块添加折叠功能:
$(document).ready(function() {$plots = $('img.plot');$chunks = $('pre').has('code');$chunks = $chunks.filter(function(idx) {返回 $(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;\"/>");} 别的 {$(this).append("<div class=\"showopt\">显示输出</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;\"/>");});//加载文档时隐藏所有块$chunks.children('code').toggle();$('pre.plot').children('img').toggle();//切换可见性的函数$('.showopt').click(function() {var label = $(this).html();如果(label.indexOf(显示")> = 0){$(this).html(label.replace("显示", "隐藏"));} 别的 {$(this).html(label.replace("隐藏", "显示"));}$(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"')``需要识别图形输出.
I really appreciate the "code_folding" feature in RMarkdown. However, what I really need is to have the code show all the time and toggle the display on the output.
---
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
```
Is there a way to toggle the output rather than the code? The best (but not ideal) solution I have thought of is to add collapse=TRUE to the chunks, but then the code and the output still display at the same time.
Link to the compiled document: http://rpubs.com/daynefiler/188408
TOC:
Full control over which chunks should be folded
Fold all chunks that contain more than one line of code/output
1. Full control over which chunks should be folded
I wanted to have the same functionality as well and did the following:
I created a JavaScript that looks as follows:
$(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');
});
});
Since I am no JS crack it might not be perfect, but it does what it is supposed to. Include it in your Rmd file:
<script src="js/hideOutput.js"></script>
I also wrote some CSS definitions to style the button:
.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;
}
After including both, the JS file and the stylesheet, you can hide chunks by wrapping a div container around them with one of the following classes:
Hide output only
<div class="fold o">
```{r}
...
```
</div>
Hide source code
<div class="fold s">
```{r}
...
```
</div>
Hide both
<div class="fold s o">
```{r}
...
```
</div>
The script detects the type of each chunk (e.g. source code, text output or plot output) and labels the buttons accordingly.
The result looks like this:
2. Fold all chunks that contain more than one line of code/output
Here is a version of the script that adds the folding feature to all chunks that are longer than one line:
$(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');
});
});
Just include it with <script src="js/hideAll.js"></script> and you don't need to wrap div containers around your code chunks.
One thing you have to add in your Rmd document though is the following global chunk option:
```{r, echo = F}
knitr::opts_chunk$set(out.extra = 'class="plot"')
```
It is needed to identify graphical output.
这篇关于如何将代码折叠添加到 rmarkdown html 文档中的输出块的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
