From 34169f3aecfca0098b9d975dc6d8cfba8883403c Mon Sep 17 00:00:00 2001
From: Raimon Tolosana-Delgado <tolosa53@fwg206.ad.fz-rossendorf.de>
Date: Thu, 15 Jul 2021 20:14:47 +0200
Subject: [PATCH] documented variogram abstract classes
---
R/variograms.R | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/R/variograms.R b/R/variograms.R
index 5de2167..5ff48e0 100644
--- a/R/variograms.R
+++ b/R/variograms.R
@@ -1068,7 +1068,10 @@ gsi.midValues.azimuthInterval <- function(x){ (x[[1]]+x[[2]])/2 }
# abstract classes
#' @title Structural function model specification
-#' @description Abstract class, containing any specification of a variogram (or covariance) model
+#' @description Abstract class, containing any specification of a variogram (or covariance) model.
+#' Members must implement a coercion method to
+#' class "gmCgram" (see [setCgram()] for an example), and (possibly) coercion to
+#' class "variogramModel" or "variogramModelList" (see [gstat::vgm()])
#' @export
#' @include compositionsCompatibility.R
#' @include gstatCompatibility.R
@@ -1143,7 +1146,10 @@ setClass("gmGaussianModel",
# abstract classes
#' @title Empirical structural function specification
-#' @description Abstract class, containing any specification of an empirical variogram (or covariance function, or variations)
+#' @description Abstract class, containing any specification of an empirical variogram
+#' (or covariance function, or variations). Members must implement a coercion method to
+#' class "gmEVario" (see [gsi.EVario2D()] for an example), and (possibly) coercion to
+#' class "gstatVariogram" (see [gstat::variogram()])
#' @export
#' @include compositionsCompatibility.R
#' @include gstatCompatibility.R
--
GitLab