}}\preformatted{---
+title: "R Markdown Report"
+output: html_document
+params:
+ mtcars: NULL
+ iris: NULL
+---
+}\if{html}{\out{
}}
+
+The libraries used in the R Markdown file must be available in
+the Shiny app environment.
+}
+\examples{
+
+# general data example
+data <- teal_data()
+data <- within(data, {
+ CO2 <- CO2
+ CO2[["primary_key"]] <- seq_len(nrow(CO2))
+})
+join_keys(data) <- join_keys(join_key("CO2", "CO2", "primary_key"))
+
+
+app <- init(
+ data = data,
+ modules = modules(
+ tm_rmarkdown(
+ label = "RMarkdown Module",
+ rmd_file = "test.Rmd"
+ )
+ )
+)
+if (interactive()) {
+ shinyApp(app$ui, app$server)
+}
+
+}
+\section{Examples in Shinylive}{
+\describe{
+ \item{example-1}{
+ \href{https://shinylive.io/r/app/#code=NobwRAdghgtgpmAXGKAHVA6ASmANGAYwHsIAXOMpMAGwEsAjAJykYE8AKcqajGIgEwCu1OAGcMAcwpxm1AJQAdCLTIyoBUrQBucAAQAeALS6AZoIgbaJdnN0AVLAFUAokrcQAxLqkQ11XfxQpFC6cAAesKgiSoHBBsZc1AD6sVA2MUEhRroA7rSkABYq7Km4uiBKuroAwgDyAEzxNQ2VzfXAwApgqIy0MCysSQDWcKxdALrjTaJwAI5JIhDsEIxEOex19XKKEAC+OwBWRCrDo6IlmbbZRycjrOc3EKccXZtdZa8teLpdPX0Dzy623cSjQqCaKny7FaqV0AF4AplcK0+EIRKJ4bpUcIxNCIFUqqQYElGP1GEN+Gslq0CbpqFB6HB-AiulgALIsClU3RsgQ4940gmk-hJEy0ESYrrkUSkbAwfhdQU7Ko7Ha0Ey6dgqcjMSw6Gy2Cr43SiIoQVgAQXQ7DBABJBLQynaZowdIwdrslGBduMgA}{Open in Shinylive}
+ \if{html}{\out{}}\preformatted{---
+\if{html}{\out{
}}\preformatted{---
title: "R Markdown Report"
output: html_document
-params:
- mtcars: NULL
- iris: NULL
---
+
+```\{r\}
+summary(mtcars) |> print()
+summary(iris) |> print()
+```
}\if{html}{\out{
}}
-The libraries used in the R Markdown file must be available in
-the Shiny app environment.
+The libraries used in the R Markdown file must be available in the deployed shiny
+app environment.
+
+When developing the R Markdown file, the working data can be simulated on a code chunk,
+which in turn can look for the presence of \code{.raw_data} object to determine if it is being
+run inside the \code{teal} module or not.
+For example:
+
+\if{html}{\out{
}}\preformatted{```\{r eval=!exists(".raw_data")\}
+mtcars <- datasets::mtcars
+iris <- datasets::iris
+```
+}\if{html}{\out{
}}
}
\examples{
From 198a462f0604f0aa034a45ad6c45934a79c442f1 Mon Sep 17 00:00:00 2001
From: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Date: Fri, 14 Nov 2025 11:16:53 +0000
Subject: [PATCH 21/22] [skip style] [skip vbump] Restyle files
---
R/tm_rmarkdown.R | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/R/tm_rmarkdown.R b/R/tm_rmarkdown.R
index d26a9b84a..2815a63c3 100644
--- a/R/tm_rmarkdown.R
+++ b/R/tm_rmarkdown.R
@@ -66,14 +66,14 @@
#' label = "RMarkdown Module",
#' rmd_content = c(
#' "---",
-#' "title: \"R Markdown Report\"",
-#' "output: html_document",
-#' "---",
-#' "",
-#' "```{r}",
-#' "summary(CO2) |> print()",
-#' "```"
-#' )
+#' "title: \"R Markdown Report\"",
+#' "output: html_document",
+#' "---",
+#' "",
+#' "```{r}",
+#' "summary(CO2) |> print()",
+#' "```"
+#' )
#' )
#' )
#' )
From 4b6d7df7c9cf668710217e72dc4747e1b938dbbf Mon Sep 17 00:00:00 2001
From: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Date: Fri, 14 Nov 2025 11:23:51 +0000
Subject: [PATCH 22/22] [skip roxygen] [skip vbump] Roxygen Man Pages Auto
Update
---
man/tm_rmarkdown.Rd | 44 +++++++++++++++++++++++++-------------------
1 file changed, 25 insertions(+), 19 deletions(-)
diff --git a/man/tm_rmarkdown.Rd b/man/tm_rmarkdown.Rd
index 3bb03aa92..1054dd3ae 100644
--- a/man/tm_rmarkdown.Rd
+++ b/man/tm_rmarkdown.Rd
@@ -59,29 +59,29 @@ The R Markdown file should be designed to accept variables available in the data
For example, if the \code{teal_data} object contains datasets named "mtcars" and "iris",
the R Markdown file can use these as variables as they will be available in the R Markdown environment.
-\if{html}{\out{
}}\preformatted{---
-title: "R Markdown Report"
-output: html_document
----
-
-```\{r\}
-summary(mtcars) |> print()
-summary(iris) |> print()
-```
-}\if{html}{\out{
}}
-
The libraries used in the R Markdown file must be available in the deployed shiny
app environment.
When developing the R Markdown file, the working data can be simulated on a code chunk,
which in turn can look for the presence of \code{.raw_data} object to determine if it is being
run inside the \code{teal} module or not.
-For example:
-\if{html}{\out{
}}\preformatted{```\{r eval=!exists(".raw_data")\}
+Example R markdown file:
+
+\if{html}{\out{
}}\preformatted{---
+title: "R Markdown Report"
+output: html_document
+---
+
+```\{r eval=!exists(".raw_data")\}
mtcars <- datasets::mtcars
iris <- datasets::iris
```
+
+```\{r\}
+summary(mtcars) |> print()
+summary(iris) |> print()
+```
}\if{html}{\out{
}}
}
\examples{
@@ -90,17 +90,23 @@ iris <- datasets::iris
data <- teal_data()
data <- within(data, {
CO2 <- CO2
- CO2[["primary_key"]] <- seq_len(nrow(CO2))
})
-join_keys(data) <- join_keys(join_key("CO2", "CO2", "primary_key"))
-
app <- init(
data = data,
modules = modules(
tm_rmarkdown(
label = "RMarkdown Module",
- rmd_content = readLines(system.file(file.path("sample_files", "test.Rmd"), package = "teal.modules.general"))
+ rmd_content = c(
+ "---",
+ "title: \"R Markdown Report\"",
+ "output: html_document",
+ "---",
+ "",
+ "```{r}",
+ "summary(CO2) |> print()",
+ "```"
+ )
)
)
)
@@ -146,8 +152,8 @@ app <- init(
\section{Examples in Shinylive}{
\describe{
\item{example-1}{
- \href{https://shinylive.io/r/app/#code=NobwRAdghgtgpmAXGKAHVA6ASmANGAYwHsIAXOMpMAGwEsAjAJykYE8AKcqajGIgEwCu1OAGcMAcwpxm1AJQAdCLTIyoBUrQBucAAQAeALS6AZoIgbaJdnN0AVLAFUAokrcQAxLqkQ11XfxQpFC6cAAesKgiSoHBBsZc1AD6sVA2MUEhRroA7rSkABYq7Km4uiBKuroAwgDyAEzxNQ2VzfXAwApgqIy0MCysSQDWcKxdALrjTaJwAI5JIhDsEIxEOex19XKKEAC+OwBWRCrDo6IlmbbZRycjrOc3EKccXZtdZa8teLpdPX0Dzy623cSjQqCaKny7FaqV0AF4AplcK0+EIRKJ4bpUcIxNCIFUqqQYElGP1GEN+Gslq0CbpqFB6HB-AiulgALIsClU3RsgQ4940gmk-hJYiqMiYxhwKD8AAyKlxonu5BgGBMtBE7HVIgwqCCBWhYFEkRESW1YnePzA5FEpGwMH4QLKeoIQygUkxXUSvD56Mk0lkQJ2tODuh2O1oJl07BU5GYlh0NlsFXxulERQgrAAguh2GCACSCWhlAszRg6Rg7XZKMC7cZAA}{Open in Shinylive}
- \if{html}{\out{
}}
+ \href{https://shinylive.io/r/app/#code=NobwRAdghgtgpmAXGKAHVA6ASmANGAYwHsIAXOMpMAGwEsAjAJykYE8AKcqajGIgEwCu1OAGcMAcwpxm1AJQAdCLTIyoBUrQBucAAQAeALS6AZoIgbaJdnN0AVLAFUAokrcQAxLqkQ11XfxQpFC6cAAesKgiSoHBBsZc1AD6sVA2MUEhRroA7rSkABYq7Km4uiBKuroAwgDyAEzxNQ1KAL6KEEpoqE0q+eyVAZm6ALxDwbiDfEIioqO608JiAxBVVaQwSYwwLADW-EQ5ECtra9RQ9HD+YwpgWACyewdHuvcCS7eTq6e62-xJxFUZHmBBOPyqt0MUM+g3Bt00pBEiF0ClRd1eT0OqywcFQREYpFRtxh3zhYCIglIqEpyIKG2SBwIgngZBJ4IhYChhjZ7OJeFhP1uAAMRSBGK0eWTRMydmx2HV6rYAD4APl0qEYKlI6X5pMFYBFQuJeqqHVOZt0HQ6tBMunYWrUlh0NlsFW+oiKEFYAEF0OxugASQS0MqB0QyHSMDoSiBgVoAXSAA}{Open in Shinylive}
+ \if{html}{\out{
}}
\if{html}{\out{
}}
}
}