Removed man/ergm-terms-taper.Rd: example was moved to Taper-ergmTerm …

…doc and references to a template.
statnet · Sep 4, 2022 · c530984 · c530984
1 parent c01c273
commit c530984
Show file tree

Hide file tree

Showing 12 changed files with 81 additions and 135 deletions.
diff --git a/R/InitErgmTerm.Kpenalty.R b/R/InitErgmTerm.Kpenalty.R
@@ -22,6 +22,7 @@
 #'    the LHS of \code{formula} if it is two-sided.
 #'
 #' @template ergmTerm-general
+#' @template ergmTerm-taper-references
 #'
 #' @concept operator
 #' @concept tapered

diff --git a/R/InitErgmTerm.M4.R b/R/InitErgmTerm.M4.R
@@ -23,6 +23,7 @@
 #'    the LHS of \code{formula} if it is two-sided.
 #'
 #' @template ergmTerm-general
+#' @template ergmTerm-taper-references
 #'
 #' @concept operator
 #' @concept tapered

diff --git a/R/InitErgmTerm.Var.R b/R/InitErgmTerm.Var.R
@@ -23,6 +23,7 @@
 #'    the LHS of \code{formula} if it is two-sided.
 #'
 #' @template ergmTerm-general
+#' @template ergmTerm-taper-references
 #'
 #' @concept operator
 #' @concept tapered

diff --git a/R/InitErgmTerm.stereo.R b/R/InitErgmTerm.stereo.R
@@ -25,6 +25,7 @@
 #'    the LHS of \code{formula} if it is two-sided.
 #'
 #' @template ergmTerm-general
+#' @template ergmTerm-taper-references
 #'
 #' @concept operator
 #' @concept tapered

diff --git a/R/InitErgmTerm.tapered.R b/R/InitErgmTerm.tapered.R
@@ -23,6 +23,12 @@
 #'    the LHS of \code{formula} if it is two-sided.
 #'
 #' @template ergmTerm-general
+#' @template ergmTerm-taper-references
+#'
+#' @examples
+#' data(florentine)
+#' m <- summary(flomarriage~edges + triangles)
+#' summary(ergm(flomarriage ~ Taper(~edges + triangles, coef=c(.1, .1),m=m)))
 #'
 #' @concept operator
 #' @concept tapered

diff --git a/man-roxygen/ergmTerm-taper-references.R b/man-roxygen/ergmTerm-taper-references.R
@@ -0,0 +1,10 @@
+#' @references
+#'
+#' * Fellows, I and Handcock, MS (2017). Removing Phase Transitions
+#'   from Gibbs Measures. \emph{Proceedings of Machine Learning
+#'   Research}, 54:289-297.
+#'
+#' * Blackburn, B and Handcock, MS (2022). Practical Network Modeling
+#'   via Tapered Exponential-family Random Graph Models. \emph{Journal
+#'   of Computational and Graphical Statistics}
+#'   \doi{10.1080/10618600.2022.2116444}.
diff --git a/man/Kpenalty-ergmTerm.Rd b/man/Kpenalty-ergmTerm.Rd
diff --git a/man/M4-ergmTerm.Rd b/man/M4-ergmTerm.Rd
diff --git a/man/Stereo-ergmTerm.Rd b/man/Stereo-ergmTerm.Rd
diff --git a/man/Taper-ergmTerm.Rd b/man/Taper-ergmTerm.Rd
diff --git a/man/Var-ergmTerm.Rd b/man/Var-ergmTerm.Rd
diff --git a/man/ergm-terms-taper.Rd b/man/ergm-terms-taper.Rd