MetricGraph is an R package used for working with data and random fields on metric graphs, such as street or river networks. The main functionality is contained in the metric_graph class, which is used for specifying metric graphs, adding data to them, visualization, and other basic functions that are needed for working with data and random fields on metric graphs. The package also implements various Gaussian fields on metric graphs, and in particular the Whittle–Matérn fields introduced in the references below.

Basic statistical tasks such as likelihood evaluation and prediction is implemented for these Gaussian fields in MetricGraph. Further, the package also contains interfaces to R-INLA and inlabru that facilitates using those packages for full Bayesian inference of general Latent Gaussian Models (LGMs) that includes Whittle-Matérn fields on metric graphs.

To get started with the package, please go to the MetricGraph: Random Fields on Metric Graphs vignette. For more comprehensive examples, please see the vignettes in the vignettes tab.

References

D. Bolin, A. Simas, J. Wallin (2024) Gaussian Whittle-Matérn fields on metric graphs. Bernoulli, 30, 1611-1639.

D. Bolin, M. Kovács, V. Kumar, A. Simas (2024) Regularity and numerical approximation of fractional elliptic differential equations on compact metric graphs. Mathematics of Computation, 93, 2439-2472.

D. Bolin, A. Simas, J. Wallin (2023) Markov properties of Gaussian random fields on compact metric graphs. ArXiv:2304.03190

D. Bolin, A. Simas, J. Wallin (2023) Statistical inference for Gaussian Whittle-Matérn fields on metric graphs. ArXiv:2304.10372

Installation instructions

The latest CRAN release of the package can be installed directly from CRAN with install.packages("MetricGraph").

It is also possible to install the CRAN version from github by using the command:

remotes::install_github("davidbolin/metricgraph", ref = "cran")

The latest stable version can be installed by using the command

remotes::install_github("davidbolin/metricgraph", ref = "stable")

in R. The development version can be installed using the command

remotes::install_github("davidbolin/metricgraph", ref = "devel")