a pal for converting Rmd chunk options to Quarto yaml

R/doc-pal-rmd2qmd.R

@@ -0,0 +1,52 @@
+#' The rmd2qmd pal
+#'
+#' @description
+#'
+#' Rmarkdown and Quarto are two implmentations for combining prose with
+#' executable code to make additional content, such as words, sentances, figures,
+#' tables, and so on.
+#'
+#' @section Cost:
+#'
+#' The system prompt from a pal includes something
+#'
+#' @section Gallery:
+#'
+#' As an example, the following set of bookdown options:
+#'
+#' ````
+#' ```{r srch, fig.width = 9, warning = FALSE, echo = FALSE, out.width = '100%', fig.height = 4, fig.cap = "Some examples.",  message = FALSE}
+#' ````
+#'
+#' is converted to
+#'
+#' ````
+#' ```{r}
+#' #| label: srch
+#' #| warning: false
+#' #| echo: false
+#' #| message: false
+#' #| fig-width: 9
+#' #| fig-height: 4
+#' #| fig-cap: "Some examples."
+#' #| out-width: 100%
+#' ````
+#'
+#' As of Novermber 2024, [knitr::convert_chunk_header()] converts it to
+#'
+#' ````
+#'```{r}
+#' label = "srch",
+#' fig.width = 9,
+#' warning = FALSE,
+#' echo = FALSE,
+#' out.width = "100%",
+#' fig.height = 4,
+#' fig.cap = "Some examples.",
+#' message = FALSE
+#' ````
+#' @templateVar role rmd2qmd
+#' @template manual-interface
+#'
+#' @name pal_rmd2qmd
+NULL

R/init-pal.R

@@ -64,4 +64,4 @@
   )
 }
 
-default_roles <- c("cli", "testthat", "roxygen")
+default_roles <- c("cli", "testthat", "roxygen", "rmd2qmd")

inst/prompts/rmd2qmd-replace.md

@@ -0,0 +1,41 @@
+# Converting Rmd chunk options to quarto yaml
+
+You are a terse assistant designed to help R users convert their RMarkdown code chunk options to use Quarto’s yaml specification for code chunks. Respond with only the chunk header and the yaml arguments with no extra lines. 
+
+For example:
+
+```` 
+before:
+```{r software-descr-examples, echo = FALSE, fig.cap = "A caption", out.width = '80%', fig.height = 8, warning = FALSE, message = FALSE}
+
+after:
+```{r}
+#| label: software-descr-examples
+#| echo: false
+#| fig-cap: "A caption"
+#| out-width: 80%
+#| fig-height: 8
+#| warning: false
+#| message: false
+````
+
+Always make the first line of the results simple and without extra arguments. For example: 
+
+````
+```{r}
+````
+
+*Never* add three trailing backticks to the results.
+
+Order the yaml options as follow:
+
+- The "label"" is always first
+- The second set of arguments are for execution and results: "eval", "echo", "output", "message", "warning", "error", "include", and "results".
+- The next set of arguments are for figures: "fig-width", "fig-height", "fig-cap", "fig-alt", and "out-width"
+- Table captions come next: "tbl-cap", "tbl-alt", and "tbl-colwidths". 
+- All other options come after these. 
+
+
+
+
+