From 1f12844d82b0b00c20be8a5a7cb95f613db068e7 Mon Sep 17 00:00:00 2001 From: Peter Solymos Date: Wed, 23 Jun 2021 14:02:20 -0600 Subject: [PATCH] Added TOC Signed-off-by: Peter Solymos --- 00-hello/README.md | 6 ++++++ 01-principal-components/README.md | 6 ++++++ 02-time-series-forecast/README.md | 9 +++++++++ README.md | 2 ++ 4 files changed, 23 insertions(+) diff --git a/00-hello/README.md b/00-hello/README.md index a6fafec..6447fef 100644 --- a/00-hello/README.md +++ b/00-hello/README.md @@ -6,6 +6,12 @@ This is a Hello World example using OpenFaaS R templates. You'll need the prerequisites listed [here](https://github.com/analythium/openfaas-rstats-templates/tree/master/examples). +- [Hello](#hello) + - [Create a new function using a template](#create-a-new-function-using-a-template) + - [Build, push, deploy the function](#build-push-deploy-the-function) + - [Testing](#testing) + - [Customize the function](#customize-the-function) + ## Create a new function using a template Create a new function called `r-hello`. diff --git a/01-principal-components/README.md b/01-principal-components/README.md index fa1c5f9..2b1fe6a 100644 --- a/01-principal-components/README.md +++ b/01-principal-components/README.md @@ -8,6 +8,12 @@ We will create a function that takes a multi-dimensional JSON array as input and You'll need the prerequisites listed [here](https://github.com/analythium/openfaas-rstats-templates/tree/master/examples). +- [Principal Component Analysis (PCA)](#principal-component-analysis-pca) + - [Create a new function using a template](#create-a-new-function-using-a-template) + - [Customize the function](#customize-the-function) + - [Build, push, deploy the function](#build-push-deploy-the-function) + - [Testing](#testing) + ## Create a new function using a template Create a new function called `r-pca`. diff --git a/02-time-series-forecast/README.md b/02-time-series-forecast/README.md index b19c405..a3e6510 100644 --- a/02-time-series-forecast/README.md +++ b/02-time-series-forecast/README.md @@ -8,6 +8,15 @@ We will create a function that pulls JSON data from public [COVID-19 data API](h You'll need the prerequisites listed [here](https://github.com/analythium/openfaas-rstats-templates/tree/master/examples). +- [Time Series Forecast](#time-series-forecast) + - [Create a new function using a template](#create-a-new-function-using-a-template) + - [Customize the function](#customize-the-function) + - [Build, push, deploy the function](#build-push-deploy-the-function) + - [Testing](#testing) + - [Use URL parameters](#use-url-parameters) + - [Use dynamic routing](#use-dynamic-routing) + - [Use r-minimal base image](#use-r-minimal-base-image) + ## Create a new function using a template Create a new function called `r-covid`. diff --git a/README.md b/README.md index d145df7..60e7504 100644 --- a/README.md +++ b/README.md @@ -48,3 +48,5 @@ __Step 5.__ Use the [`faas-cli`](https://github.com/openfaas/faas-cli) and pull ```bash faas-cli template pull https://github.com/analythium/openfaas-rstats-templates ``` + +Now you can pick one of the examples and continue.