From 96c1bf1411b1b05bd3953b12f2333dabd49be063 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andrzej=20W=C3=B3jtowicz?= <andre@amu.edu.pl>
Date: Sun, 17 Jul 2016 03:01:33 +0200
Subject: [PATCH] updated readme

---
 README.md          | 17 ++++++++++++++++-
 s3-make-readme.Rmd | 15 +++++++++++++++
 2 files changed, 31 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9024e13..a8c482e 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,22 @@ Andrzej Wójtowicz
 
 
 
-Document generation date: 2016-07-17 02:31:21.
+Document generation date: 2016-07-17 02:59:19.
+
+This project preprocesses a few datasets from [UC Irvine Machine Learning
+Repository](https://archive.ics.uci.edu/ml/) into tidy R object files.
+It focuses on the binary classification datasets and saves only complete cases
+within a dataset.
+
+**R software**: [Microsoft R Open](https://mran.microsoft.com/open/) (3.2.5)
+
+**Reproducibility library**: [checkpoint](https://github.com/RevolutionAnalytics/checkpoint)
+
+**Reproducibility procedure**:
+
+ 1. Run *s1-download-data.R* to download original datasets.
+ 2. Run *s2-preprocess-data.R* to preprocess the datasets.
+ 3. Optionally knit s*3-make-readme.Rmd* to get an overview of the preprocessed datasets.
 
 
 # Table of Contents
diff --git a/s3-make-readme.Rmd b/s3-make-readme.Rmd
index 7b968b3..70c8efe 100644
--- a/s3-make-readme.Rmd
+++ b/s3-make-readme.Rmd
@@ -13,6 +13,21 @@ source('init.R')
 
 Document generation date: `r Sys.time()`.
 
+This project preprocesses a few datasets from [UC Irvine Machine Learning
+Repository](https://archive.ics.uci.edu/ml/) into tidy R object files.
+It focuses on the binary classification datasets and saves only complete cases
+within a dataset.
+
+**R software**: [Microsoft R Open](https://mran.microsoft.com/open/) (`r paste0(R.version$major, ".", R.version$minor)`)
+
+**Reproducibility library**: [checkpoint](https://github.com/RevolutionAnalytics/checkpoint)
+
+**Reproducibility procedure**:
+
+ 1. Run *s1-download-data.R* to download original datasets.
+ 2. Run *s2-preprocess-data.R* to preprocess the datasets.
+ 3. Optionally knit s*3-make-readme.Rmd* to get an overview of the preprocessed datasets.
+
 ```{r show-datasets, results='asis'}
 
 cat("\n# Table of Contents\n\n")