Creating an R markdown/notebook template file: can I define code chunks to be folded when the `.rmd` file is opened in Rstudio?

Question

I'm creating a template file for R markdown / R notebook. There are several code chunks that I wish will remain folded when the .rmd is being opened. Is this possible?

Example

Let's say that we have the following code, and we save it (without the ##) into a file named my_file.rmd

## ---
## title: "R Notebook"
## output: html_notebook
## ---

## # step 0 -- my predefind functions
## ```{r my_func()}
## my_func <- function(x) {
##   x + 1
## }
## ```

## ```{r my_func_2()}
## my_func_2 <- function(x) {
##   x / 6
## }
## ```

## # step 1 -- your code here
## ```{r}

## ```

Is there a way we can open my_file.rmd — using RStudio — with the chunks {r my_func()} and {r my_func_2()} being folded upon opening the file?

I believe Rstudio has some IDE code folding feature, but it has to be when defining functions — Daniel_j_iii, Jun 08 '21 at 16:10
@DanielJachetta, I'm not sure I understand your comment. What do you mean by "*when defining the functions*"? — Emman, Jun 09 '21 at 08:02

score 0 · Answer 1 · answered Jun 08 '21 at 09:10

0

You coud use code_folding: hide YAML combined with class.source = 'fold-show' for he chuncks you want to show, see:

---
title: "R Notebook"
output:
  html_document:
    code_folding: hide
---

# step 0 -- my predefined functions
```{r my_func()}
my_func <- function(x) {
  x + 1
}
```

```{r my_func_2()}
my_func_2 <- function(x) {
  x / 6
}
```

# step 2 -- your code here
```{r class.source = 'fold-show'}
my_func_3 <- function(x) {
  x / 6
}
```

answered Jun 08 '21 at 09:10

Waldi

39,242
6
30
78

thanks! But my question is aimed at the `.rmd` file (the source code), not the `html` output. – Emman Jun 08 '21 at 09:19

score 0 · Answer 2 · answered Jun 09 '21 at 23:33

0

As long as you have a proper R chunks, you can fold the code inside the Rmd in Rstudio. I highly suggest you read up on knitr spin() too

answered Jun 09 '21 at 23:33

Daniel_j_iii

3,041
2
11
27

Thanks. The problem is not how to fold, but how to have the folded chunk remain folded when *re-*opening the `.rmd` file next time. – Emman Jun 12 '21 at 14:12
The next best thing is just a keyboard shortcut for folding the Chunk while in the IDE for hopefully a faster workflow. `Fold Selected windows(Alt+L) MacOS(Cmd+Option+L)` – Daniel_j_iii Jun 12 '21 at 14:43

Creating an R markdown/notebook template file: can I define code chunks to be folded when the `.rmd` file is opened in Rstudio?

Example

2 Answers2