updated tdt docs

.Rbuildignore

@@ -3,3 +3,4 @@
 ^LICENSE\.md$
 ^\.github$
 ^cran-comments\.md$
+^CRAN-SUBMISSION$

DESCRIPTION

@@ -8,13 +8,18 @@ Authors@R:
            email = "[email protected]",
            comment = c(ORCID = "0000-0001-5215-0316"))
 Description: Visualize your 'Tidyverse' data analysis pipelines via the 
-    'Tidy Data Tutor' web application.
+    'Tidy Data Tutor'(<https://tidydatatutor.com/>) web application.
 License: MIT + file LICENSE
+URL: https://github.com/seankross/tidydatatutor
+BugReports: https://github.com/seankross/tidydatatutor/issues
 Encoding: UTF-8
-Imports: 
+Imports:
     clipr,
+    knitr,
     rstudioapi
 RoxygenNote: 7.1.2
 Suggests: 
+    rmarkdown,
+    dplyr,
     testthat (>= 3.0.0)
 Config/testthat/edition: 3

NAMESPACE

@@ -4,8 +4,12 @@ export(go)
 export(go_code)
 export(go_paste)
 export(go_selection)
+export(tdt_chunk)
+export(tdt_file)
+export(tdt_link)
 importFrom(clipr,clipr_available)
 importFrom(clipr,read_clip)
+importFrom(knitr,knit_code)
 importFrom(rstudioapi,getSourceEditorContext)
 importFrom(rstudioapi,verifyAvailable)
 importFrom(utils,URLencode)

R/go.R

@@ -2,6 +2,8 @@
 #'
 #' @importFrom rstudioapi verifyAvailable getSourceEditorContext
 #' @importFrom utils browseURL
+#' @returns A string with an appropriately formatted URL to Tidy Data Tutor
+#' (invisibly).
 #' @export
 #' @examples
 #' \dontrun{
@@ -33,6 +35,8 @@ go <- function(){
 #'
 #' @importFrom rstudioapi verifyAvailable getSourceEditorContext
 #' @importFrom utils browseURL
+#' @returns A string with an appropriately formatted URL to Tidy Data Tutor
+#' (invisibly).
 #' @export
 #' @examples
 #' \dontrun{
@@ -54,6 +58,8 @@ go_selection <- function(){
 #'
 #' @importFrom clipr clipr_available read_clip
 #' @importFrom utils browseURL
+#' @returns A string with an appropriately formatted URL to Tidy Data Tutor
+#' (invisibly).
 #' @export
 #' @examples
 #' \dontrun{
@@ -85,6 +91,8 @@ go_paste <- function(){
 #'
 #' @param code A string of R code.
 #' @importFrom utils browseURL
+#' @returns A string with an appropriately formatted URL to Tidy Data Tutor
+#' (invisibly).
 #' @export
 #' @examples
 #' \dontrun{

R/tdt_url.R

@@ -7,3 +7,61 @@ tdt_url <- function(x){
     sep = ""
   )
 }
+
+#' Create a Link to Tidy Data Tutor
+#'
+#' @param code A string or vector of strings containing R code.
+#' @returns A string with an appropriately formatted URL to Tidy Data Tutor.
+#' @export
+#' @examples
+#' \dontrun{
+#'
+#' code <- "library(dplyr)
+#' Formaldehyde %>% mutate(Sum = carb + optden)"
+#'
+#' tdt_link(code)
+#'}
+tdt_link <- function(code) {
+  tdt_url(code)
+}
+
+#' Create a Link to Tidy Data Tutor from an R Code Chunk
+#'
+#' @param chunk The name of an R code chunk in the current R Markdown document.
+#' @importFrom knitr knit_code
+#' @returns A string with an appropriately formatted URL to Tidy Data Tutor.
+#' @export
+#' @examples
+#' \dontrun{
+#'
+#' <!--- In an R Markdown document: --->
+#' ```{r mtcars-1}
+#' library(dplyr)
+#'
+#' mtcars %>%
+#'   select(mpg, cyl, hp) %>%
+#'   group_by(cyl) %>%
+#'   summarise(mean(hp))
+#' ```
+#'
+#' [See this pipeline in Tidy Data Tutor](`r tdt_chunk("mtcars-1")`)
+#'}
+tdt_chunk <- function(chunk) {
+  tdt_url(as.character(knit_code[["get"]](chunk)))
+}
+
+#' Create a Link to Tidy Data Tutor from an R Code File
+#'
+#' @param file The path to an R code file.
+#' @returns A string with an appropriately formatted URL to Tidy Data Tutor.
+#' @export
+#' @examples
+#' \dontrun{
+#'
+#' r_code_file <- system.file("test", "test-1.R", package = "tidydatatutor")
+#' tdt_file(r_code_file)
+#' }
+tdt_file <- function(file) {
+  stopifnot(file.exists(file))
+  tdt_url(readLines(file))
+}

README.md

@@ -53,6 +53,30 @@ Then open it in Tidy Data Tutor by running this in the console:
 tidydatatutor::go_paste()
 ```
 
+## R Markdown Support
+
+Generate links to Tidy Data Tutor in R Markdown with named R code chunks:
+
+    ---
+    output: md_document
+    ---
+
+    ```{r setup, include=FALSE}
+    knitr::opts_chunk$set(message = FALSE)
+    library(tidydatatutor)
+    ```
+
+    ```{r mtcars-1}
+    library(dplyr)
+
+    mtcars %>% 
+      select(mpg, cyl, hp) %>% 
+      group_by(cyl) %>% 
+      summarize(mean(hp))
+    ```
+
+    [See this pipeline in Tidy Data Tutor](`r tdt_chunk("mtcars-1")`)
+
 ## RStudio Add-in
 
 Access Tidy Data Tutor from the Addins drop down menu in RStudio:

inst/test/test-1.R

@@ -0,0 +1,6 @@
+library(dplyr)
+
+mtcars %>%
+  select(mpg, cyl, hp) %>%
+  group_by(cyl) %>%
+  summarise(mean(hp))

inst/test/test-1.Rmd

@@ -0,0 +1,19 @@
+---
+output: md_document
+---
+
+```{r setup, include=FALSE}
+knitr::opts_chunk$set(message = FALSE)
+library(tidydatatutor)
+```
+
+```{r mtcars-1}
+library(dplyr)
+
+mtcars %>% 
+  select(mpg, cyl, hp) %>% 
+  group_by(cyl) %>% 
+  summarise(mean(hp))
+```
+
+[See this pipeline in Tidy Data Tutor](`r tdt_chunk("mtcars-1")`)

inst/test/test-1.md

@@ -0,0 +1,16 @@
+    library(dplyr)
+
+    mtcars %>% 
+      select(mpg, cyl, hp) %>% 
+      group_by(cyl) %>% 
+      summarise(mean(hp))
+
+    ## # A tibble: 3 × 2
+    ##     cyl `mean(hp)`
+    ##   <dbl>      <dbl>
+    ## 1     4       82.6
+    ## 2     6      122. 
+    ## 3     8      209.
+
+[See this pipeline in Tidy Data
+Tutor](https://tidydatatutor.com/vis.html#code=library%28dplyr%29%0A%0Amtcars%20%25%3E%25%20%0A%20%20select%28mpg%2C%20cyl%2C%20hp%29%20%25%3E%25%20%0A%20%20group_by%28cyl%29%20%25%3E%25%20%0A%20%20summarise%28mean%28hp%29%29&d=2021-12-09&lang=r&v=v1)

tests/testthat/test-tdt_url.R → tests/testthat/test-tdt_link.R

@@ -1,10 +1,10 @@
-test_that("tdt_url makes the correct url", {
+test_that("tdt_link makes the correct url", {
 
   input <- c("library(dplyr)", "library(palmerpenguins)", "", "penguins %>%",
              "  select(species, bill_length_mm) %>%", "  group_by(species) %>%",
              "  arrange(desc(bill_length_mm), .by_group = TRUE) %>% ", "  slice(1)"
   )
   correct <- paste0("https://tidydatatutor.com/vis.html#code=library%28dplyr%29%0Alibrary%28palmerpenguins%29%0A%0Apenguins%20%25%3E%25%0A%20%20select%28species%2C%20bill_length_mm%29%20%25%3E%25%0A%20%20group_by%28species%29%20%25%3E%25%0A%20%20arrange%28desc%28bill_length_mm%29%2C%20.by_group%20%3D%20TRUE%29%20%25%3E%25%20%0A%20%20slice%281%29&d=",
                     as.character(Sys.Date()), "&lang=r&v=v1")
-  expect_equal(correct, tdt_url(input))
+  expect_equal(correct, tdt_link(input))
 })