Skip to content
Emmanuel Blondel edited this page May 23, 2014 · 8 revisions

Welcome to the RFigisGeo wiki!

RFigisGeo is a R package aimed to facilitate geoprocessing in R. The package will offer functionalities to facilitate communication with OGC web-services, to run specific geospatial-related algorithms, and to be used as basis for building standard web-processings.

Use

Getting Started

Developments

Development status

Check the [Change History] (https://github.com/openfigis/RFigisGeo/wiki/Change-History) which provides a list of fixes and improvements by milestone

Issue reporting

Issues can be reported at https://github.com/openfigis/RFigisGeo/issues

Unit tests

  • Each new feature should be accompanied with unit tests, by using the testthat R package.
  • For each R-script file named script.R, a correspond test file should be created in inst/tests directory, using the writing convention test_<script>.R
  • The test_<script>.R should have the following structure:
require(RFigisGeo, quietly = TRUE) #load the RFigisGeo package
require(testthat) # load the testthat package
context("script") # create a unit test context for the given script file

#unit test 1
test_that("Test1",{
   ...
})

#unit test 2
test_that("Test2",{
   ...
})

Build tests

  • After any modification of the source code (bug fix, enhancement, added feature), a package build should be tested by the developer using the command R CMD check RFigisGeo (requires installation of an R instance and RTools). Such program will run a set of check operations required for a proper package build, including the unit tests.
  • In order to guarantee a proper R package build, the R CMD check will be performed automatically after each commit, through Travis Continuous Integration (see https://travis-ci.org/openfigis/RFigisGeo). This second build test is required to ensure users will be able to successfully install the package from Github.

The build status is reported here below:

branch build status
master Build Status
Clone this wiki locally