From a17505e11676b8340a9d26a797bb3e0fba65c09b Mon Sep 17 00:00:00 2001
From: kaneplusplus <kaneplusplus@gmail.com>
Date: Tue, 11 Feb 2020 16:58:33 -0500
Subject: [PATCH] Appveyor.

---
 README.Rmd   | 16 +++++++++++++---
 README.md    | 25 ++++++++++++++++++++++---
 appveyor.yml | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 87 insertions(+), 6 deletions(-)
 create mode 100644 appveyor.yml

diff --git a/README.Rmd b/README.Rmd
index c753833..84b6db6 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -21,10 +21,20 @@ knitr::opts_chunk$set(
 [![Codecov test coverage](https://codecov.io/gh/kaneplusplus/listdown/branch/master/graph/badge.svg)](https://codecov.io/gh/kaneplusplus/listdown?branch=master)
 <!-- badges: end -->
 
-The goal of listdown is to programmatically create R Markdown files from 
-named lists. The package currently supports the creation of workflowr, 
-pdf, word, html, and slide documents.
+## Overview 
 
+The listdown package provides functions to programmatically create R Markdown files from 
+named lists. It is intended for data analysis pipelines where the presentation of the results
+is separated from their creation. For this use case, a data processing (or analysis) is performed
+and the results are provided in a single named list, organized heirarchically. From the list, 
+listdown creates a workflowr, pdf, word, or html page. List element names denote sections, subsections,
+subsubsection, etc. and the list elements contain the data structure to be presented including
+graphs and tables. The goal of the package is not to provide a finished, readable document. It is to provide a document  with all tables and visualization that will appear. This serves as a starting point from which a user  can organize outputs, describe a study, discuss results, and provide conclusions.
+
+listdown provides a reproducible means for _analytical_ document elements. It is most compatible with
+data analysis pipelines where the data format is fixed but the analyses are either being updated, 
+which may affect _narrative_ elements including the result discussion and conclusion, or where the
+experiment is different, which affects all narrative elements.
 
 ## Installation
 
diff --git a/README.md b/README.md
index 9ea8982..82afb1a 100644
--- a/README.md
+++ b/README.md
@@ -13,9 +13,28 @@ status](https://ci.appveyor.com/api/projects/status/github/kaneplusplus/listdown
 coverage](https://codecov.io/gh/kaneplusplus/listdown/branch/master/graph/badge.svg)](https://codecov.io/gh/kaneplusplus/listdown?branch=master)
 <!-- badges: end -->
 
-The goal of listdown is to programmatically create R Markdown files from
-named lists. The package currently supports the creation of workflowr,
-pdf, word, html, and slide documents.
+## Overview
+
+The listdown package provides functions to programmatically create R
+Markdown files from named lists. It is intended for data analysis
+pipelines where the presentation of the results is separated from their
+creation. For this use case, a data processing (or analysis) is
+performed and the results are provided in a single named list, organized
+heirarchically. From the list, listdown creates a workflowr, pdf, word,
+or html page. List element names denote sections, subsections,
+subsubsection, etc. and the list elements contain the data structure to
+be presented including graphs and tables. The goal of the package is not
+to provide a finished, readable document. It is to provide a document
+with all tables and visualization that will appear. This serves as a
+starting point from which a user can organize outputs, describe a study,
+discuss results, and provide conclusions.
+
+listdown provides a reproducible means for *analytical* document
+elements. It is most compatible with data analysis pipelines where the
+data format is fixed but the analyses are either being updated, which
+may affect *narrative* elements including the result discussion and
+conclusion, or where the experiment is different, which affects all
+narrative elements.
 
 ## Installation
 
diff --git a/appveyor.yml b/appveyor.yml
new file mode 100644
index 0000000..3a75e16
--- /dev/null
+++ b/appveyor.yml
@@ -0,0 +1,52 @@
+# DO NOT CHANGE the "init" and "install" sections below
+
+# Download script file from GitHub
+init:
+  ps: |
+        $ErrorActionPreference = "Stop"
+        Invoke-WebRequest http://raw.github.com/krlmlr/r-appveyor/master/scripts/appveyor-tool.ps1 -OutFile "..\appveyor-tool.ps1"
+        Import-Module '..\appveyor-tool.ps1'
+
+install:
+  ps: Bootstrap
+
+cache:
+  - C:\RLibrary
+
+environment:
+  NOT_CRAN: true
+  # env vars that may need to be set, at least temporarily, from time to time
+  # see https://github.com/krlmlr/r-appveyor#readme for details
+  # USE_RTOOLS: true
+  # R_REMOTES_STANDALONE: true
+
+# Adapt as necessary starting from here
+
+build_script:
+  - travis-tool.sh install_deps
+
+test_script:
+  - travis-tool.sh run_tests
+
+on_failure:
+  - 7z a failure.zip *.Rcheck\*
+  - appveyor PushArtifact failure.zip
+
+artifacts:
+  - path: '*.Rcheck\**\*.log'
+    name: Logs
+
+  - path: '*.Rcheck\**\*.out'
+    name: Logs
+
+  - path: '*.Rcheck\**\*.fail'
+    name: Logs
+
+  - path: '*.Rcheck\**\*.Rout'
+    name: Logs
+
+  - path: '\*_*.tar.gz'
+    name: Bits
+
+  - path: '\*_*.zip'
+    name: Bits