Updated DESCRIPTION and README files

README.md

@@ -1,2 +1,40 @@
-# r_kehra
-Collection of utility functions used in the KEHRA project
+kehra: an R package to collect, assemble and model air pollution, weather and health data
+=======
+
+[![DOI](https://zenodo.org/badge/9118/cvitolo/r_kehra.svg)](https://zenodo.org/badge/latestdoi/9118/cvitolo/r_kehra)
+[![CRAN Status Badge](http://www.r-pkg.org/badges/version/kehra)](http://cran.r-project.org/web/packages/kehra)
+[![CRAN Total Downloads](http://cranlogs.r-pkg.org/badges/grand-total/kehra)](http://cran.rstudio.com/web/packages/kehra/index.html)
+[![CRAN Monthly Downloads](http://cranlogs.r-pkg.org/badges/kehra)](http://cran.rstudio.com/web/packages/kehra/index.html)
+
+Collect, assemble and model air pollution, weather and health data is a Big Data problem. Here are some utility functions developed as part of the British Council's funded KEHRA project.
+
+# Dependencies
+The kehra package is dependent on a number of CRAN packages. Install them first:
+
+```R
+install.packages(c("Hmisc", "raster", "reshape2", "stringr", "sp", "xts", "zoo"))
+library(devtools)
+```
+
+
+# Installation
+The stable version of the **kehra** package is available from CRAN:
+
+```R
+install.packages("kehra")
+```
+
+This github repository contains the development version (latest version but potentially unstable), which can be installed via devtools:
+
+```R
+install_github("cvitolo/r_kehra", subdir = "kehra")
+```
+
+Now, load the kehra package:
+
+```R
+library(kehra)
+```
+
+# Leave your feedback
+I would greatly appreciate if you could leave your feedbacks via email ([email protected]).

kehra/DESCRIPTION

@@ -1,12 +1,15 @@
 Package: kehra
 Type: Package
-Title: Collection of utility functions used in the KEHRA project
+Title: An R package to collect, assemble and model air pollution, weather and health data
 Version: 0.1
 Date: 2016-05-17
-Author: Claudia Vitolo
+Author: Claudia Vitolo [aut, cre], Allan Tucker [aut], Andrew Russell [aut]
 Maintainer: Claudia Vitolo <[email protected]>
-Description: Collection of utility functions used in the KEHRA project. It refers to the multidimensional analysis of pollution and health.
+URL: http://cvitolo.github.io/kehra/
+BugReports: https://github.com/cvitolo/kehra/issues
+Description: Collection of utility functions used in the KEHRA project. It refers to the multidimensional analysis of air pollution, weather and health data.
 Depends: R (>= 2.14.0)
 Imports: Hmisc, raster, reshape2, stringr, sp, xts, zoo
 License: GPL-3
-RoxygenNote: 5.0.1
+Repository: GitHub
+RoxygenNote: 5.0.1