From 691c72de715cdd8db62f3be6a86034cfcf51c9eb Mon Sep 17 00:00:00 2001
From: "Pavel N. Krivitsky" <p.krivitsky@unsw.edu.au>
Date: Tue, 8 Oct 2024 17:44:08 +1100
Subject: [PATCH] Updated Roxygen templates from ergm.

---
 man-roxygen/ergmTerm-x-attrname.R       | 23 ++++++++++++++++-------
 man/edgecovages-ergmTerm-8222522a.Rd    | 23 ++++++++++++++++-------
 man/edgecovmeanage-ergmTerm-46204f5f.Rd | 23 ++++++++++++++++-------
 3 files changed, 48 insertions(+), 21 deletions(-)

diff --git a/man-roxygen/ergmTerm-x-attrname.R b/man-roxygen/ergmTerm-x-attrname.R
index 58934c9a..dcfe2bdb 100644
--- a/man-roxygen/ergmTerm-x-attrname.R
+++ b/man-roxygen/ergmTerm-x-attrname.R
@@ -7,10 +7,19 @@
 #
 #  Copyright 2008-2024 Statnet Commons
 ################################################################################
-#' @param x,attrname either a square matrix of covariates, one for
-#'   each possible edge in the network, the name of a network
-#'   attribute of covariates, or a network; if the latter, or if the
-#'   network attribute named by `x` is itself a network, optional
-#'   argument `attrname` provides the name of the quantitative edge
-#'   attribute to use for covariate values (in this case, missing
-#'   edges in `x` are assigned a covariate value of zero).
+#' @param x,attrname a specification for the dyadic covariate: either
+#'   one of the following, or the name of a network attribute
+#'   containing one of the following: \describe{
+#'
+#'   \item{a covariate matrix}{with dimensions \eqn{n \times n}{n*n}
+#'     for unipartite networks and \eqn{b \times (n-b)}{b*(n-b)} for
+#'     bipartite networks; `attrname`, if given, is used to construct
+#'     the term name.}
+#'
+#'   \item{a network object}{with the same size and bipartitedness as
+#'     LHS; `attrname`, if given, provides the name of the
+#'     quantitative edge attribute to use for covariate values (in
+#'     this case, missing edges in `x` are assigned a covariate value
+#'     of zero).}
+#'
+#' }
diff --git a/man/edgecovages-ergmTerm-8222522a.Rd b/man/edgecovages-ergmTerm-8222522a.Rd
index 128da678..5ef6d3f4 100644
--- a/man/edgecovages-ergmTerm-8222522a.Rd
+++ b/man/edgecovages-ergmTerm-8222522a.Rd
@@ -8,13 +8,22 @@
 # binary: edgecov.ages(x, attrname=NULL)
 }
 \arguments{
-\item{x, attrname}{either a square matrix of covariates, one for
-each possible edge in the network, the name of a network
-attribute of covariates, or a network; if the latter, or if the
-network attribute named by \code{x} is itself a network, optional
-argument \code{attrname} provides the name of the quantitative edge
-attribute to use for covariate values (in this case, missing
-edges in \code{x} are assigned a covariate value of zero).}
+\item{x, attrname}{a specification for the dyadic covariate: either
+one of the following, or the name of a network attribute
+containing one of the following: \describe{
+
+\item{a covariate matrix}{with dimensions \eqn{n \times n}{n*n}
+for unipartite networks and \eqn{b \times (n-b)}{b*(n-b)} for
+bipartite networks; \code{attrname}, if given, is used to construct
+the term name.}
+
+\item{a network object}{with the same size and bipartitedness as
+LHS; \code{attrname}, if given, provides the name of the
+quantitative edge attribute to use for covariate values (in
+this case, missing edges in \code{x} are assigned a covariate value
+of zero).}
+
+}}
 }
 \description{
 Weighted sum of ages of extant ties
diff --git a/man/edgecovmeanage-ergmTerm-46204f5f.Rd b/man/edgecovmeanage-ergmTerm-46204f5f.Rd
index cb90f001..b9a1492d 100644
--- a/man/edgecovmeanage-ergmTerm-46204f5f.Rd
+++ b/man/edgecovmeanage-ergmTerm-46204f5f.Rd
@@ -8,13 +8,22 @@
 # binary: edgecov.mean.age(x, attrname=NULL, emptyval=0)
 }
 \arguments{
-\item{x, attrname}{either a square matrix of covariates, one for
-each possible edge in the network, the name of a network
-attribute of covariates, or a network; if the latter, or if the
-network attribute named by \code{x} is itself a network, optional
-argument \code{attrname} provides the name of the quantitative edge
-attribute to use for covariate values (in this case, missing
-edges in \code{x} are assigned a covariate value of zero).}
+\item{x, attrname}{a specification for the dyadic covariate: either
+one of the following, or the name of a network attribute
+containing one of the following: \describe{
+
+\item{a covariate matrix}{with dimensions \eqn{n \times n}{n*n}
+for unipartite networks and \eqn{b \times (n-b)}{b*(n-b)} for
+bipartite networks; \code{attrname}, if given, is used to construct
+the term name.}
+
+\item{a network object}{with the same size and bipartitedness as
+LHS; \code{attrname}, if given, provides the name of the
+quantitative edge attribute to use for covariate values (in
+this case, missing edges in \code{x} are assigned a covariate value
+of zero).}
+
+}}
 
 \item{emptyval}{can be used to specify the value returned if the network is empty (or all extant edges have been weighted 0). This is, technically, an arbitrary value, but it should
 not have a substantial effect unless a non-negligible fraction of