Remove iris data use

Author: thomasp85

DESCRIPTION

@@ -38,6 +38,7 @@ Suggests:
     htmlwidgets,
     mirai,
     nanoparquet,
+    palmerpenguins,
     quarto,
     rapidoc,
     readr,

README.Rmd

@@ -67,36 +67,36 @@ function(msg) {
   )
 }
 
-#* Plot out data from the iris dataset
+#* Plot out data from the palmer penguins dataset
 #*
 #* @get /plot
 #*
-#* @query spec:enum|setosa, versicolor, virginica| If provided, filter the
+#* @query spec:enum|Adelie, Chinstrap, Gentoo| If provided, filter the
 #* data to only this species
 #*
 #* @serializer png{width = 700, height = 500}
 #* @serializer jpeg{width = 700, height = 500}
 #*
 #* @async
 function(query) {
-  myData <- iris
+  myData <- palmerpenguins::penguins
   title <- "All Species"
 
   # Filter if the species was specified
   if (!is.null(query$spec)){
     title <- paste0("Only the '", query$spec, "' Species")
-    myData <- subset(iris, Species == query$spec)
+    myData <- subset(myData, species == query$spec)
     if (nrow(myData) == 0) {
       abort_internal_error("Missing data for {query$spec}")
     }
   }
 
   plot(
-    myData$Sepal.Length,
-    myData$Petal.Length,
+    myData$flipper_length_mm,
+    myData$bill_length_mm,
     main=title,
-    xlab="Sepal Length",
-    ylab="Petal Length"
+    xlab="Flipper Length (mm)",
+    ylab="Bill Length (mm)"
   )
 }
 ```

README.md

@@ -58,36 +58,36 @@ function(msg) {
   )
 }
 
-#* Plot out data from the iris dataset
+#* Plot out data from the palmer penguins dataset
 #*
 #* @get /plot
 #*
-#* @query spec:enum|setosa, versicolor, virginica| If provided, filter the
+#* @query spec:enum|Adelie, Chinstrap, Gentoo| If provided, filter the
 #* data to only this species
 #*
 #* @serializer png{width = 700, height = 500}
 #* @serializer jpeg{width = 700, height = 500}
 #*
 #* @async
 function(query) {
-  myData <- iris
+  myData <- palmerpenguins::penguins
   title <- "All Species"
 
   # Filter if the species was specified
   if (!is.null(query$spec)){
     title <- paste0("Only the '", query$spec, "' Species")
-    myData <- subset(iris, Species == query$spec)
+    myData <- subset(myData, species == query$spec)
     if (nrow(myData) == 0) {
       abort_internal_error("Missing data for {query$spec}")
     }
   }
 
   plot(
-    myData$Sepal.Length,
-    myData$Petal.Length,
+    myData$flipper_length_mm,
+    myData$bill_length_mm,
     main=title,
-    xlab="Sepal Length",
-    ylab="Petal Length"
+    xlab="Flipper Length (mm)",
+    ylab="Bill Length (mm)"
   )
 }
 ```

vignettes/files/apis/01-01-quickstart.R

@@ -10,30 +10,30 @@ function(msg) {
   )
 }
 
-#* Plot out data from the iris dataset
+#* Plot out data from the palmer penguins dataset
 #*
 #* @get /plot
 #*
 #* @query spec:string If provided, filter the data to only this species
-#* (e.g. 'setosa')
+#* (e.g. 'Adelie')
 #*
 #* @serializer png
 #*
 function(query) {
-  myData <- iris
+  myData <- palmerpenguins::penguins
   title <- "All Species"
 
   # Filter if the species was specified
   if (!is.null(query$spec)){
     title <- paste0("Only the '", query$spec, "' Species")
-    myData <- subset(iris, Species == query$spec)
+    myData <- subset(myData, species == query$spec)
   }
 
   plot(
-    myData$Sepal.Length,
-    myData$Petal.Length,
+    myData$flipper_length_mm,
+    myData$bill_length_mm,
     main=title,
-    xlab="Sepal Length",
-    ylab="Petal Length"
+    xlab="Flipper Length (mm)",
+    ylab="Bill Length (mm)"
   )
 }

vignettes/plumber.qmd

@@ -66,7 +66,7 @@ res <- papi$test_request(req)
 code_chunk(res$body, "json")
 ```
 
-The `/plot` endpoint will show you a simple plot of some data from the iris dataset.
+The `/plot` endpoint will show you a simple plot of some data from the palmerpenguins dataset.
 
 ```{r}
 #| echo: false
@@ -81,18 +81,18 @@ If you see something like the above: congratulations! You've just created your f
 
 ## Specifying the Inputs
 
-You may have noticed that the functions that define our endpoints accept parameters. These parameters allow us to customize the behavior of our endpoints. In the example above we use two different ways of specifying the outputs. For the `/echo/...` handler we take a variable part of the path and use this as an argument. You can see above that "test" is used in the resulting json object and had we provided a different path, e.g. `/echo/plumber` then "plumber" would have been used instead. In the other handler we rely on the "query string" to pass in an optional argument. If you visit <http://localhost:8080/plot?spec=setosa>, you should see a similar graph to the one you saw before, but now the dataset has been filtered to only include the "setosa" species in the iris dataset.
+You may have noticed that the functions that define our endpoints accept parameters. These parameters allow us to customize the behavior of our endpoints. In the example above we use two different ways of specifying the outputs. For the `/echo/...` handler we take a variable part of the path and use this as an argument. You can see above that "test" is used in the resulting json object and had we provided a different path, e.g. `/echo/plumber` then "plumber" would have been used instead. In the other handler we rely on the "query string" to pass in an optional argument. If you visit <http://localhost:8080/plot?spec=Adelie>, you should see a similar graph to the one you saw before, but now the dataset has been filtered to only include the "Adelie" species in the palmerpenguins dataset.
 
 ```{r}
 #| echo: false
 #| results: asis
-req <- fiery::fake_request("http://localhost:8080/plot?spec=setosa")
+req <- fiery::fake_request("http://localhost:8080/plot?spec=Adelie")
 res <- papi$test_request(req)
 
 cat('<img src="data:image/png;base64,', base64enc::base64encode(res$body), '">')
 ```
 
-As you might have guessed, the `spec=setosa` portion of the URL sets the `spec` element in `query` to `setosa`. More details on how Plumber processes inputs are available in the [Routing & Input article](./routing-and-input.html).
+As you might have guessed, the `spec=Adelie` portion of the URL sets the `spec` element in `query` to `Adelie`. More details on how Plumber processes inputs are available in the [Routing & Input article](./routing-and-input.html).
 
 ## Customizing The Output
 

vignettes/routing-and-input.qmd

@@ -346,7 +346,7 @@ The following details the mapping of the scalar type names that you can use in y
 
 You can also specify any of the above as an array, by enclosing it in `[...]`, (e.g. `[integer]` for an array of integers). Arrays can even be nested (e.g. `[[integer]]` for an array of arrays of integers).
 
-Lastly, it is possible to specify "object", which will be cast to lists in R. The syntax for this is `{name:Type, ...}` and allows you to provide concise specifications for very complex data structures (e.g. the specification for the iris dataset is `{Sepal.Length:number,Sepal.Width:number,Petal.Length:number,Petal.Width:number,Species:string}`. It is unlikely that you'll need objects for path and query parameters, but request bodies will often be in the form of an object.
+Lastly, it is possible to specify "object", which will be cast to lists in R. The syntax for this is `{name:Type, ...}` (e.g. `{eruptions:[number], waiting:[number]}` for the `faithful` dataset) and allows you to provide concise specifications for very complex data structures. It is unlikely that you'll need objects for path and query parameters, but request bodies will often be in the form of an object.
 
 ### Defaults