Add plumbertableau-example (#81)

* Add plumbertableau-example

* Add additional R exclusions to .gitignore

* Add filter to worfklow

* Update manifest with all dependencies

* Allow and include renv

* Remove errant renv outside of extension folder

* Fix content name

Author: cgraham-rs

.github/workflows/extensions.yml

@@ -39,6 +39,7 @@ jobs:
             landing-page: extensions/landing-page/**
             stock-api-fastapi: extensions/stock-api-fastapi/**
             connectwidgets-example: extensions/connectwidgets-example/**
+            plumbertableau-example: extensions/plumbertableau-example/**
             fastapitableau-example: extensions/fastapitableau-example/**
 
   # Runs for each extension that has changed from `simple-extension-changes`

.gitignore

@@ -1,7 +1,7 @@
 # RStudio
 .Rproj.user
-**/renv/
-.Rprofile
+.RData
+.Rhistory
 
 # Quarto
 .quarto/

extensions/plumbertableau-example/.Rprofile

@@ -0,0 +1 @@
+source("renv/activate.R")

extensions/plumbertableau-example/README.md

@@ -0,0 +1,19 @@
+# Tableau R Extension
+
+## About this example
+
+plumbertableau is an R package that enables R developers to build Plumber APIs that function as Tableau Analytics Extensions. These extensions can be leveraged from Tableau workbooks to allow real time requests from Tableau to R. This extension builds on top of Tableau's example Superstore dataset.
+
+
+## Learn more
+
+* [Learn how to use this extension from Tableau](https://github.com/sol-eng/tableau-examples/tree/main/superstore)
+* [Documentation for plumbertableau](https://rstudio.github.io/plumbertableau/)
+* [Configuring Posit Connect for use with Tableau](https://docs.posit.co/rsc/integration/tableau/)
+
+## Requirements
+
+* Posit Connect license allows API publishing
+* R version 3.2 or higher
+
+<!-- NOTE: this file is generated -->

extensions/plumbertableau-example/manifest.json

@@ -0,0 +1,28 @@
+library(plumber)
+library(plumbertableau)
+library(outForest)
+library(dplyr)
+
+#* @apiTitle Outlier Detection for Tableau
+#* @apiDescription Detect outliers in real-time on Tableau data using a Random Forest
+
+#* Calculate outliers on input data
+#* @tableauArg sales:numeric Numeric values representing sales for a given transaction
+#* @tableauArg profit:numeric Numeric values representing profit for a given transaction
+#* @tableauReturn logical A vector indicating the outlier status of each original observation
+#* @post /detect-outliers
+function(sales, profit) {
+  dat <- tibble(sales, profit)
+  out <- outForest(dat)
+  outlier_rows <- outliers(out) %>%
+    select(row) %>%
+    distinct()
+
+  dat %>%
+    mutate(row = 1:n(),
+           outlier = row %in% outlier_rows$row) %>%
+    pull(outlier)
+}
+
+#* @plumber
+tableau_extension

extensions/plumbertableau-example/plumber.R

@@ -0,0 +1,16 @@
+Version: 1.0
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes

extensions/plumbertableau-example/plumbertableau-example.Rproj

@@ -0,0 +1,7 @@
+library/
+local/
+cellar/
+lock/
+python/
+sandbox/
+staging/