Skip to content

Commit

Permalink
add pkgdown examples to qc documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
zsigmas committed Jun 5, 2024
1 parent cc6a9f5 commit dda6d41
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
18 changes: 18 additions & 0 deletions inst/validation/pkgdown_examples/vignettes/_pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
template:
bootstrap: 5

navbar:
type: inverted
structure:
left: [intro, reference, articles, tutorials, news, qc]
components:
qc:
text: Quality Control
href: articles/qc.html

articles:

- title: Quality Control
desc: Quality Control
contents:
- qc
32 changes: 32 additions & 0 deletions inst/validation/pkgdown_examples/vignettes/qc.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "Quality Control"
output:
rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Quality Control}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
echo = FALSE
)
```

```{r, params, echo = FALSE, include = FALSE}
val_param_rds <- "../inst/validation/results/val_param.rds"
val_param_rds_exists <- file.exists(val_param_rds)
if (file.exists(val_param_rds)) params <- readRDS(val_param_rds)
```

```{r, results = "asis", echo = FALSE}
if (val_param_rds_exists) {
res <- knitr::knit_child("../inst/validation/val_report_child.Rmd", quiet = TRUE, envir = environment())
cat(res, sep = "\n")
} else {
"No quality control results found"
}
```

0 comments on commit dda6d41

Please sign in to comment.