reinstated vignette in md

Put it back whilst we sort out pkgdown
EvolEcolGroup · Nov 3, 2023 · 1d2b1d0 · 1d2b1d0
1 parent 2c6e09c
commit 1d2b1d0
Show file tree

Hide file tree

Showing 24 changed files with 1,389 additions and 13 deletions.
diff --git a/README.md b/README.md
diff --git a/data-raw/README.md b/data-raw/README.md
@@ -0,0 +1,42 @@
+
+# geoGraph
+
+<!-- badges: start -->
+[![R-CMD-check](https://github.com/thibautjombart/geograph/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/thibautjombart/geograph/actions/workflows/R-CMD-check.yaml)
+<!-- badges: end -->
+
+`geoGraph` aims at implementing graph approaches for geographic data.
+In `geoGraph`, a given geographic area is modelled by a fine regular grid, where each vertice
+has a set of spatial coordinates and a set of attributes, which can be for instance habitat
+descriptors, or the presence/abundance of a given species.
+'Travelling' within the geographic area can then be easily modelled as moving between connected vertices.
+The cost of moving from one vertex to another can be defined according to attribute values, which
+allows for instance to define friction routes based on habitat.
+
+`geoGraph` harnesses the full power of graph algorithms implemented in R by the *graph*
+and *RBGL* (R Boost Graph Library) packages.
+In particular, RBGL is an interface between R and the comprehensive *Boost Graph Library* in C++,
+which provides fast and efficient implementations of a wide range of graph algorithms.
+Once we have defined frictions for an entire geographic area, we can easily, for instance, find the least
+costs path from one location to another, or find the most parsimonious way of connecting a set of locations.
+
+
+Interfacing spatial data and graphs can be a complicated task.
+The purpose of `geoGraph` is to provide tools to achieve and simplify this 'preliminary' step.
+This is achieved by defining new classes of objects which are essentially geo-referenced graphs
+with node attributes (`gGraph` objects), and interfaced spatial data (`gData` objects).
+
+## Installation
+
+You can install the development version of `geoGraph` from [GitHub](https://github.com/) with:
+
+``` r
+install.packages("devtools")
+devtools::install_github("thibautjombart/geoGraph")
+```
+
+## How the package works
+
+A detailed introduction to the functionalities of `geoGraph` is found in the
+overview article of its website.
+
diff --git a/vignettes/figs/bookmark-1.png b/vignettes/figs/bookmark-1.png
diff --git a/vignettes/figs/citiesPlot2-1.png b/vignettes/figs/citiesPlot2-1.png
diff --git a/vignettes/figs/cities_plot-1.png b/vignettes/figs/cities_plot-1.png
diff --git a/vignettes/figs/citiesplot-1.png b/vignettes/figs/citiesplot-1.png
diff --git a/vignettes/figs/closeNode-1.png b/vignettes/figs/closeNode-1.png
diff --git a/vignettes/figs/connectivityPlot-1.png b/vignettes/figs/connectivityPlot-1.png
diff --git a/vignettes/figs/geoslide-1.png b/vignettes/figs/geoslide-1.png
diff --git a/vignettes/figs/plot_edges-1.png b/vignettes/figs/plot_edges-1.png
diff --git a/vignettes/figs/unnamed-chunk-23-1.png b/vignettes/figs/unnamed-chunk-23-1.png
diff --git a/vignettes/figs/unnamed-chunk-24-1.png b/vignettes/figs/unnamed-chunk-24-1.png
diff --git a/vignettes/figs/unnamed-chunk-29-1.png b/vignettes/figs/unnamed-chunk-29-1.png
diff --git a/vignettes/figs/unnamed-chunk-32-1.png b/vignettes/figs/unnamed-chunk-32-1.png
diff --git a/vignettes/figs/unnamed-chunk-34-1.png b/vignettes/figs/unnamed-chunk-34-1.png
diff --git a/vignettes/figs/unnamed-chunk-36-1.png b/vignettes/figs/unnamed-chunk-36-1.png
diff --git a/vignettes/figs/unnamed-chunk-38-1.png b/vignettes/figs/unnamed-chunk-38-1.png
diff --git a/vignettes/figs/unnamed-chunk-39-1.png b/vignettes/figs/unnamed-chunk-39-1.png
diff --git a/vignettes/figs/unnamed-chunk-41-1.png b/vignettes/figs/unnamed-chunk-41-1.png
diff --git a/vignettes/figs/unnamed-chunk-42-1.png b/vignettes/figs/unnamed-chunk-42-1.png
diff --git a/vignettes/figs/wg10kdefplot-1.png b/vignettes/figs/wg10kdefplot-1.png
diff --git a/vignettes/figs/wg10plot-1.png b/vignettes/figs/wg10plot-1.png
diff --git a/vignettes/figs/zoomin-1.png b/vignettes/figs/zoomin-1.png
diff --git a/vignettes/figs/zoomout-1.png b/vignettes/figs/zoomout-1.png