Skip to content
Emmanuel Blondel edited this page Oct 18, 2019 · 19 revisions

geoflow – R engine to orchestrate and run geospatial (meta)data workflows

DOI

R engine to orchestrate and run geospatial (meta)data workflows


If you wish to sponsor geoflow, do not hesitate to contact me

Many thanks to the following organizations that have provided fundings for strenghtening the geoflow package:


Table of contents

1. Overview
2. Package status
3. Credits
4. User guide
   4.1 How to install geoflow
   4.2 How to use geoflow
   4.3 How to create a geoflow configuration file
      4.3.1 Create manually a configuration file
      4.3.2 Use the configuration Shiny User Interface
5. Issue reporting

1. Overview and vision


The principle of geoflow is to offer a simple framework in R to execute and orchestrate geospatial (meta)data management and publication tasks in an automated way.

2. Development status


On GitHub under consolidation.

First version in CRAN expected end 2019.

3. Credits


(c) 2019, Emmanuel Blondel, Julien Barde, Wilfried Heintz

Package distributed under MIT license.

If you use geoflow, w would be very grateful if you can add a citation in your published work. By citing geoflow, beyond acknowledging the work, you contribute to make it more visible and guarantee its growing and sustainability. For citation, please use the DOI: DOI

4. User guide


4.1 How to install geoflow

For now, the package can be installed from Github

install.packages("devtools")

Once the devtools package loaded, you can use the install_github to install geoflow. By default, package will be installed from master which is the current version in development (likely to be unstable).

require("remotes")
install_github("eblondel/geoflow")

4.2 How to use geoflow in R

In R, using geoflow consists essentially in running the function ``executeWorkflow", which takes a single parameter: the name of a configuration file in JSON format:

executeWorkflow("config.json")

The workflow that is going to be executed is entirely described in a configuration file. The main preparatory work of the data manager will then to prepare the configuration file, depending on the tasks to perform.

Note: It is planned to offer a shiny app interface, through geoflow, that will allow configure the workflow in a user-friendly manner (The shiny app will then take care of creating the appropriate JSON configuration file in a transparent way)

4.3 How to create a geoflow configuration file

To create a geoflow configuration file, first let's describe how the configuration file is structured.

TODO

4.3.1 Create manually a configuration file

TODO

4.3.2 Use the geoflow configuration Shiny User Interface

NOT YET AVAILABLE

5. Issue reporting


Issues can be reported at https://github.com/eblondel/geoflow/issues

Clone this wiki locally