Folding code and results

[aloboa]

Could it be possible to optionally fold both the code and the results? With the code folded, seeing the results is often confusing. Specifying results='hide' in the rmd document is not a solution, as when the code is unfolded you wish seeing the results.
Best if this results folding option could be set by chunks (when results are graphic, you normally want them displayed by default).
Just a suggestion.

[cderv]

Do you mean that you'll be able to do the code and result folding with the button ?
Or do you want to produce just a document with no code appearing and some results not appearing too ?

For the latter, you have the chunk options from knitr:

• echo = FALSE to not show code
• results = "hide" to not show output
• include=FALSE to run the code but hide both
• eval=FALSE lets you control which code in not run

Is this something that answer your suggestion or is it different ?
Thanks.

[aloboa]

I mean being "able to do the code and result folding with the button " (or perhaps 2 buttons).
The second option is what I point as inconvenient: if I set results=hide, the results will be hiding
even if the user unfolds the code, which is also confusing. In other words, in the present situation we either show results, which is confusing with the code folded, or do not show the results, which is confusing with the code unfolded. Having a button to fold/unfold the results would be consistent with having a button to fold/unfold the code. For me, one single button folding/unfolding both code and results would be sufficient.
Thanks

[cderv]

Thanks for the precision.
Currently, I do not think this is an existing feature. this surely could be added with basis the code from the hide code button.

However, generally you use Rmarkdown to mix results and texts, I think it is rare case willing to hide everything. All graph, html table and every output would disappear leaving only title and comments. In this case, you may want to provide two documents.

Right now, you may be able to it on a per document basis with some css and js code inside you document. A class could be added to the result and some js code could hide these elements when a button is clicked. Just an idea.

If you come with an implementation and want to do a PR, I am sure the rmarkdown team will be happy to review it.

[aloboa]

Thanks for your answer.
I was conscious of making a suggestion for future development.
Let me disagree with your statement:

However, generally you use Rmarkdown to mix results and texts, I think it is rare case willing to hide everything. All graph, html table and every output would disappear leaving only title and comments

We use folding code precisely when we want the reader to concentrate on the text , and then, unfold the code to see an example and/or the actual details. In many cases (I do not say always), having the code folded but seeing the results, as it is currently the case, is very confusing, and forces the author to write extra text to explain why those results are there. This extra text is often redundant with the code which, in the case of R, is very readable. I agree there are cases in which seeing the results and not the code makes sense, e.g. for graphics. This is why I'm suggesting having folded/unfolded results chunks as an option.
Hope I've made my suggestion clear. You should just take it as a user feed-back for future improvements of rmarkdown.

[cderv]

Absolutely ! Thank you for the suggestion. Don't get me wrong - I just wanted to share another user feedback that is another point of view, and I was trying to help. If there is an opportunity to add this option and to offer that way more customisation for different usage, that is great!

[yihui]

That sounds like a reasonable feature request to me, but I have no idea when it could be implemented (by whom). Thanks for the suggestion!

[aloboa]

An example of what I propose. Do not know how these guys did it:
https://geoscripting-wur.github.io/IntroToRaster/#WUR_Geoscripting_

[cderv]

This document is made using https://github.com/jimhester/knitrBootstrap, an R 📦 that extend knitr and offer this feature (among others). It is also on CRAN

Code/Output block and plot visibility can be toggled with a mouse click

• Globally
• Per language

It is made possible through CSS and JS code and html tag, class and ID creating with R code.
Another example from the package.

Is this what you are looking for ?

[aloboa]

Yes, this is it.
Actually, this example is nicer:
http://rpubs.com/jimhester/6826

I've found that while knitrBootstrap offers this advantage of both code and output folding, it does have the disadvantage of not
reproducing plots done with ggplotly(), which works fine using html_document() in render().
Also, there is always the risk of packages going unsupported: knitr is very stable now and we can be confident on its long-term support. Including this output folding in knitr itself would be better.

Agus

[mgagliol]

This feature would be especially useful for teaching! I currently use code_folding: hide when giving solutions to exercises but it does not hide the output, which is weird and can act as a "spoiler".

[remlapmot]

Replying to @mgagliol , I picked up some tips from @yihui 's advice to generate both questions and solutions output documents from the same Rmd file using a parameterised Rmd file described here.

The parameter is passed to control whether your solution chunks are shown or hidden, i.e. whether the solutions chunks have option include set to TRUE or FALSE. This is done using the params: option in the YAML header or your call to rmarkdown::render(..., params = list(...)) which is then passed to a setup chunk which sets knitr::opts_chunk$set(include = params$...).

An example Rmd document looks something like the following.

---
params:
  solutions: FALSE
---

```{r setup}
knitr::opts_chunk$set(include = params$solutions)
```

... Rest of your document.

I have written a small package to do this here and there is an example Rmd file here.

[atusy]

Here I give you a knit hook that makes outputs and plots foldable via HTML details tag.

---
output: html_document
---

```{r, include=FALSE}
hooks = knitr::knit_hooks$get()
hook_foldable = function(type) {
  force(type)
  function(x, options) {
    res = hooks[[type]](x, options)
    
    if (isFALSE(options[[paste0("fold.", type)]])) return(res)
    
    paste0(
      "<details><summary>", type, "</summary>\n\n",
      res,
      "\n\n</details>"
    )
  }
}
knitr::knit_hooks$set(
  output = hook_foldable("output"),
  plot = hook_foldable("plot")
)
```

# Folding

```{r}
rnorm(10)
plot(iris)
```

# Disable folding

```{r, fold.output=FALSE, fold.plot=FALSE}
rnorm(10)
plot(iris)
```

[atusy]

Here's another approach with Lua Filter.
It can be combined with knit_hooks for automation.
https://gist.github.com/atusy/f2b5b992e45c68ab6823499f2339c6e6