Skip to content

Commit c7f0862

Browse files
authored
Update chunk labels in vignettes (#310)
1 parent 084a187 commit c7f0862

6 files changed

Lines changed: 17 additions & 17 deletions

File tree

vignettes/anndataR.Rmd

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ vignette: >
1313
%\VignetteEncoding{UTF-8}
1414
---
1515

16-
```{r, include = FALSE}
16+
```{r options, include = FALSE}
1717
knitr::opts_chunk$set(
1818
collapse = TRUE,
1919
comment = "#>"
@@ -34,14 +34,14 @@ This package differs from [**{zellkonverter}**](https://bioconductor.org/package
3434

3535
Install using either **{BiocManager}** or from GitHub using **{pak}**:
3636

37-
```{r, eval = FALSE}
37+
```{r install-BiocManager, eval = FALSE}
3838
if (!requireNamespace("BiocManager", quietly = TRUE)) {
3939
install.packages("BiocManager")
4040
}
4141
BiocManager::install("anndataR")
4242
```
4343

44-
```{r, eval = FALSE}
44+
```{r install-pak, eval = FALSE}
4545
if (!require("pak", quietly = TRUE)) {
4646
install.packages("pak")
4747
}
@@ -54,7 +54,7 @@ Here's a quick example of how to use **{anndataR}**.
5454

5555
First, we fetch an example `.h5ad` file included in the package:
5656

57-
```{r}
57+
```{r h5ad-path}
5858
library(anndataR)
5959
6060
h5ad_path <- system.file("extdata", "example.h5ad", package = "anndataR")
@@ -169,6 +169,6 @@ write_h5ad(obj, tmpfile)
169169

170170
## Session info
171171

172-
```{r}
172+
```{r sessioninfo}
173173
sessionInfo()
174174
```

vignettes/development_status.Rmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ vignette: >
99

1010
The following tables show the status of the implementation of each feature in the package:
1111

12-
```{r include=FALSE}
12+
```{r impl-table, include=FALSE}
1313
library(tibble)
1414
library(knitr)
1515
library(rprojroot)
@@ -132,7 +132,7 @@ status_formatted <- status |>
132132

133133
## Objects
134134

135-
```{r echo=FALSE, results="asis"}
135+
```{r impl-table-objects, echo=FALSE, results="asis"}
136136
# loop over each of the classes and print the table as markdown
137137
all_classes <- unique(status_formatted$class)
138138
object_classes <- all_classes[!all_classes %in% c("Seurat", "SingleCellExperiment")]
@@ -152,7 +152,7 @@ for (class_name in object_classes) {
152152

153153
## Conversion
154154

155-
```{r echo=FALSE, results="asis"}
155+
```{r impl-table-conversion, echo=FALSE, results="asis"}
156156
# loop over each of the classes and print the table as markdown
157157
for (class_name in c("SingleCellExperiment", "Seurat")) {
158158
cat("### ", class_name, "\n\n", sep = "")
@@ -175,6 +175,6 @@ for (class_name in c("SingleCellExperiment", "Seurat")) {
175175

176176
## Session info
177177

178-
```{r}
178+
```{r sessioninfo}
179179
sessionInfo()
180180
```

vignettes/known_issues.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ vignette: >
99

1010
This document lists known issues with the package and suggests possible solutions.
1111

12-
```{r echo=FALSE, results="asis"}
12+
```{r known-issues, echo=FALSE, results="asis"}
1313
# how to get a file from a package
1414
data <- yaml::read_yaml(system.file("known_issues.yaml", package = "anndataR"))$known_issues
1515
@@ -33,6 +33,6 @@ for (i in seq_along(data)) {
3333

3434
## Session info
3535

36-
```{r}
36+
```{r sessioninfo}
3737
sessionInfo()
3838
```

vignettes/software_design.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ vignette: >
88
---
99

1010

11-
```{r, include = FALSE}
11+
```{r options, include = FALSE}
1212
knitr::opts_chunk$set(
1313
collapse = TRUE,
1414
comment = ""
@@ -46,6 +46,6 @@ Notation:
4646

4747
## Session info
4848

49-
```{r}
49+
```{r sessioninfo}
5050
sessionInfo()
5151
```

vignettes/usage_seurat.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ vignette: >
88
%\VignetteEncoding{UTF-8}
99
---
1010

11-
```{r, include = FALSE}
11+
```{r options, include = FALSE}
1212
knitr::opts_chunk$set(
1313
collapse = TRUE,
1414
comment = "#>",
@@ -132,6 +132,6 @@ The mapping arguments can also be passed directly to `write_h5ad()`.
132132

133133
## Session info
134134

135-
```{r}
135+
```{r sessioninfo}
136136
sessionInfo()
137137
```

vignettes/usage_singlecellexperiment.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ vignette: >
88
%\VignetteEncoding{UTF-8}
99
---
1010

11-
```{r, include = FALSE}
11+
```{r options, include = FALSE}
1212
knitr::opts_chunk$set(
1313
collapse = TRUE,
1414
comment = "#>",
@@ -130,6 +130,6 @@ The mapping arguments can also be passed directly to `write_h5ad()`.
130130

131131
## Session info
132132

133-
```{r}
133+
```{r sessioninfo}
134134
sessionInfo()
135135
```

0 commit comments

Comments
 (0)