improve readme, re: put vignettes in more prominent place

ACDIVOCATech · Oct 26, 2019 · 4ffb7fe · 4ffb7fe
1 parent 182b756
commit 4ffb7fe
Show file tree

Hide file tree

Showing 13 changed files with 45 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -27,9 +27,26 @@ against different targets.
 devtools::install_github("ACDIVOCATech/bulletchartr")
 ```
 
+## Introductory Vignettes
+
+  - [Intro to Bullet
+    Charts](https://acdivocatech.github.io/bulletchartr/articles/intro-to-bullet-charts.html)
+  - [Intro to bulletchartr data
+    inputs](https://acdivocatech.github.io/bulletchartr/articles/intro-inputs.html)
+  - [Intro to bulletchartr function
+    arguments](https://acdivocatech.github.io/bulletchartr/articles/intro-arguments.html)
+
+## Quick Overview
+
 The **bullet chart** was invented by [Stephen
 Few](https://www.perceptualedge.com/articles/misc/Bullet_Graph_Design_Spec.pIndicatorData),
-for the purpose of showing tons of info in a condensed form in KPIs.
+for the purpose of showing tons of info in a condensed form in KPIs. It
+is basically a variation of a bar chart that allows you to compare one
+measure against other metrics such as a target value and/or some
+qualitative measures of performance (ex. low - medium - high or poor -
+satisfactory - good). These qualitative labels are displayed as varying
+intensities of a single color from dark (low/bad/negative) to light
+(high/good/positive).
 
 The output of the `bullet_chart()` function most closely resembles
 Stephen Few’s design:
@@ -79,10 +96,6 @@ bullet_chart_vline(file_name = read_example("Indicators_Targets_ext.xlsx"))
 
 <img src="man/figures/README-unnamed-chunk-3-1.png" width="100%" />
 
-Please read the package vignette, [“Introduction to bullet
-charts”](https://acdivocatech.github.io/bulletchartr/articles/intro-to-bullet-charts.html)
-for a more detailed overview\!
-
 ## Future direction
 
 Currently this package is geared more toward non-R using M\&E people

diff --git a/README.rmd b/README.rmd
@@ -42,7 +42,15 @@ This package, `bulletchartr` is based on visualizing M&E deliverables or "Indica
 devtools::install_github("ACDIVOCATech/bulletchartr")
 ```
 
-The __bullet chart__ was invented by [Stephen Few](https://www.perceptualedge.com/articles/misc/Bullet_Graph_Design_Spec.pIndicatorData), for the purpose of showing tons of info in a condensed form in KPIs.
+## Introductory Vignettes
+
+- [Intro to Bullet Charts](https://acdivocatech.github.io/bulletchartr/articles/intro-to-bullet-charts.html)
+- [Intro to bulletchartr data inputs](https://acdivocatech.github.io/bulletchartr/articles/intro-inputs.html)
+- [Intro to bulletchartr function arguments](https://acdivocatech.github.io/bulletchartr/articles/intro-arguments.html)
+
+## Quick Overview
+
+The __bullet chart__ was invented by [Stephen Few](https://www.perceptualedge.com/articles/misc/Bullet_Graph_Design_Spec.pIndicatorData), for the purpose of showing tons of info in a condensed form in KPIs. It is basically a variation of a bar chart that allows you to compare one measure against other metrics such as a target value and/or some qualitative measures of performance (ex. low - medium - high or poor - satisfactory - good). These qualitative labels are displayed as varying intensities of a single color from dark (low/bad/negative) to light (high/good/positive).
 
 The output of the `bullet_chart()` function most closely resembles Stephen Few's design: 
 
@@ -74,8 +82,6 @@ bullet_chart_wide(file_name = read_example("Indicators_Targets_ext.xlsx"),
 bullet_chart_vline(file_name = read_example("Indicators_Targets_ext.xlsx"))
 ```
 
-Please read the package vignette, ["Introduction to bullet charts"](https://acdivocatech.github.io/bulletchartr/articles/intro-to-bullet-charts.html) for a more detailed overview!
-
 ## Future direction
 
 Currently this package is geared more toward non-R using M&E people (therefore, the Excel file input alongside a dataframe input), however as we develop this package further we want to go towards being able to make the `bullet_chart` functions more customizable for general use cases. 
diff --git a/docs/articles/intro-arguments.html b/docs/articles/intro-arguments.html
diff --git a/docs/articles/intro-arguments_files/figure-html/cal-custom-1.png b/docs/articles/intro-arguments_files/figure-html/cal-custom-1.png
diff --git a/docs/articles/intro-arguments_files/figure-html/cal-type2-1.png b/docs/articles/intro-arguments_files/figure-html/cal-type2-1.png
diff --git a/docs/articles/intro-to-bullet-charts_files/figure-html/bulletchart-time-1.png b/docs/articles/intro-to-bullet-charts_files/figure-html/bulletchart-time-1.png
diff --git a/docs/articles/intro-to-bullet-charts_files/figure-html/vline-1.png b/docs/articles/intro-to-bullet-charts_files/figure-html/vline-1.png
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/reference/figures/README-unnamed-chunk-1-1.png b/docs/reference/figures/README-unnamed-chunk-1-1.png
diff --git a/docs/reference/figures/README-unnamed-chunk-2-1.png b/docs/reference/figures/README-unnamed-chunk-2-1.png
diff --git a/docs/reference/read_example.html b/docs/reference/read_example.html
diff --git a/man/figures/README-unnamed-chunk-1-1.png b/man/figures/README-unnamed-chunk-1-1.png
diff --git a/man/figures/README-unnamed-chunk-2-1.png b/man/figures/README-unnamed-chunk-2-1.png