envirocar / envirocar

Import and analysis functions for the R environment for statistical computing and graphics

enviroCaR

Import and analysis functions for the R environment for statistical computing and graphics

Installation

Install dependencies

You need the trajectories package, which is available from CRAN; on the R prompt, type

install.packages("trajectories")

or install the development version from github:

library(devtools)
install_gihub("edzer/trajectories")

Install enviroCaR

The enviroCaR package is not on CRAN yet, so please download and install the package manually. For this to work must have both git (http://git-scm.com/downloads) and R (see documentation here for Windows) on your path. Then run the following commands in the command line:

git clone https://github.com/enviroCar/enviroCaR
R CMD INSTALL enviroCaR

Usage

Take a look at the demos to see how to use the package:

library(enviroCaR)
demo(package = "enviroCaR")

Bug reporting

If you find a bug or run into problems, please open a new issue on GitHub: https://github.com/enviroCar/enviroCaR/issues

Before you submit the bug, consider these guidelines.

Development

Contributing

Contributions to this package are always welcome. Take a look at the issues to see what tasks are pending and join the enviroCar mailing list/forum to discuss new ideas.

We follow the fork & pull development modell, so please fork the project and send us your contributions as pull requests.

No work should be done without an issue describing the task.

Documentation

We use roxygen comments in the R files. Take a look at the roxygen2 documentation use it and read these guidelines on documenting functions.

About

See http://envirocar.org to learn more about the project.

License

This R exention package is licensed under GPL version 2 or later.

envirocar's Issues

Support data formats in download

The API supports several ouput formats (shp, csv, rdf) which should be accessible easily via the importEnviroCar method.

New demo importFormats shows how these different outputs look and that they can (partially) be re-used in R.

Test cases

Implement a couple of unit tests for the most important functions (must work offline) to make the development more stable. Use the testthat package.

Vignette

We need a vignette to present the capabilities of the package and to showcase what you can do with enviroCar data.

Default values for API

Add a constants.R class that has a list of the available api endpoints (/api, /dev/api) and uses the first of that list as default.

Authors@R field

use the extended functionality of the Authors@R field

example sections

we need example sections in the help pages:

' @examples

Add contribute.md

See https://wiki.52north.org/bin/view/Contributor/ContributeMd