Document R benchmark recipes

kgryte · kgryte · commit f76d78edf6de · 2018-01-10T17:27:40.000-08:00
diff --git a/tools/make/lib/benchmark/README.md b/tools/make/lib/benchmark/README.md
@@ -254,6 +254,42 @@ The recipe recognizes the following environment variables:
 
 This recipe is useful when wanting to run a list of Python benchmark files generated by some other command (e.g., a filtered list of changed Python benchmark files obtained via `git diff`).
 
+* * *
+
+### R
+
+#### benchmark-r
+
+Runs R benchmarks.
+
+<!-- run-disable -->
+
+```bash
+$ make benchmark-r
+```
+
+The recipe recognizes the following environment variables:
+
+-   **BENCHMARKS_FILTER**: filepath pattern; e.g., `.*/blas/base/dasum/.*`.
+
+This recipe is useful when wanting to glob for R benchmark files (e.g., run all R benchmarks for a particular package).
+
+#### benchmark-r-files
+
+Runs a specified list of R benchmark files.
+
+<!-- run-disable -->
+
+```bash
+$ make benchmark-r-files FILES='/foo/benchmark.R /bar/benchmark.R'
+```
+
+The recipe recognizes the following environment variables:
+
+-   **FILES**: list of R benchmark files.
+
+This recipe is useful when wanting to run a list of R benchmark files generated by some other command (e.g., a filtered list of changed R benchmark files obtained via `git diff`).
+
 </section>
 
 <!-- /.usage -->
