Restracturing of the repository after moving the package to the root …

…directory.

.Rbuildignore

@@ -0,0 +1,7 @@
+^.*\.Rproj$
+^\.Rproj\.user$
+^CONDUCT\.md$
+
+README.Rmd
+README.md
+README_cache

.gitignore

@@ -24,3 +24,6 @@ r_kehra.Rproj
 data/*
 images/*
 *.tar.gz
+
+README_cache
+kehra.Rproj

CONDUCT.md

@@ -0,0 +1,25 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who 
+contribute through reporting issues, posting feature requests, updating documentation,
+submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for
+everyone, regardless of level of experience, gender, gender identity and expression,
+sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or
+imagery, derogatory comments or personal attacks, trolling, public or private harassment,
+insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments,
+commits, code, wiki edits, issues, and other contributions that are not aligned to this 
+Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed 
+from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by 
+opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the Contributor Covenant 
+(http:contributor-covenant.org), version 1.0.0, available at 
+http://contributor-covenant.org/version/1/0/0/

kehra/DESCRIPTION → DESCRIPTION

@@ -1,7 +1,7 @@
 Package: kehra
 Type: Package
 Title: Collect, Assemble and Model Air Pollution, Weather and Health Data
-Version: 0.1
+Version: 0.3
 Date: 2016-06-09
 Author: Claudia Vitolo [aut, cre], Allan Tucker [aut], Andrew Russell [aut]
 Maintainer: Claudia Vitolo <[email protected]>

README.Rmd

@@ -0,0 +1,64 @@
+---
+output: 
+  github_document
+---
+
+<!-- Edit the README.Rmd only!!! The README.md is generated automatically from README.Rmd. -->
+
+kehra: an R package to collect, assemble and model air pollution, weather and health data
+==============================================================
+
+```{r echo=FALSE}
+knitr::opts_chunk$set(
+  comment = '#>',
+  collapse = TRUE,
+  warning = FALSE,
+  message = FALSE,
+  eval = FALSE,
+  cache = TRUE
+)
+```
+
+[![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)
+
+The package [kehra](https://cran.r-project.org/package=kehra) allows to collect, assemble and model air pollution, weather and health data. The package is being developed as part of the British Council's funded KEHRA project and builds upon other R packages such as [rdefra](https://cran.r-project.org/package=rdefra) to retrieve pollution data from the UK-AIR database hosted by the UK Department for Enviornment, Food and Rural Affairs, and the [bnlearn](https://cran.r-project.org/package=bnlearn) to model the assembled database using Bayesian Networks.
+
+## Dependencies
+
+The kehra package depends on the Geospatial Data Abstraction Library (gdal) and some additional CRAN packages. Check for missing dependencies and install them using the commands below:
+
+```{r}
+packs <- c('Hmisc', 'raster', 'reshape2', 'stringr', 'sp', 'xts', 'zoo', 
+           'devtools', 'rgdal')
+new.packages <- packs[!(packs %in% installed.packages()[,'Package'])]
+if(length(new.packages)) install.packages(new.packages)
+```
+
+## Installation
+
+Get the released version from CRAN:
+
+```{r}
+install.packages('kehra')
+```
+
+Or the development version from github using [devtools](https://github.com/hadley/devtools):
+
+```{r}
+devtools::install_github('kehraProject/kehra')
+```
+
+Load the kehra package:
+
+```{r, eval = TRUE}
+library('kehra')
+```
+
+## Meta
+
+* Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.
+* Please [report any issues or bugs](https://github.com/kehraProject/kehra/issues).
+* License: [GPL-3](https://opensource.org/licenses/GPL-3.0)
+* Get citation information for `kehra` in R doing `citation(package = 'kehra')`