Documented and exported ergm_conlist() methods.

Author: krivit

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: ergm
-Version: 4.12.1-8001
+Version: 4.12.1-8002
 Date: 2026-02-27
 Title: Fit, Simulate and Diagnose Exponential-Family Models for Networks
 Authors@R: c(

NAMESPACE

@@ -6,6 +6,7 @@ S3method("%ergmlhs%",network)
 S3method("%ergmlhs%<-",ergm_state_full)
 S3method("%ergmlhs%<-",network)
 S3method("-",ergm_levels_spec_function)
+S3method("[",ergm_conlist)
 S3method("param_names<-",ergm_model)
 S3method(AIC,ergm)
 S3method(BIC,ergm)
@@ -34,6 +35,7 @@ S3method(as.rlebdm,ergm_state)
 S3method(as.rlebdm,matrix)
 S3method(as.rlebdm,network)
 S3method(as.rlebdm,rlebdm)
+S3method(c,ergm_conlist)
 S3method(c,ergm_model)
 S3method(coef,ergm)
 S3method(compress,rlebdm)
@@ -58,6 +60,10 @@ S3method(ergm_attr_levels,list)
 S3method(ergm_attr_levels,logical)
 S3method(ergm_attr_levels,matrix)
 S3method(ergm_attr_levels,numeric)
+S3method(ergm_conlist,"NULL")
+S3method(ergm_conlist,ergm_conlist)
+S3method(ergm_conlist,formula)
+S3method(ergm_conlist,term_list)
 S3method(ergm_get_vattr,"function")
 S3method(ergm_get_vattr,AsIs)
 S3method(ergm_get_vattr,character)
@@ -238,6 +244,7 @@ export(ergm_MCMC_slave)
 export(ergm_SAN_slave)
 export(ergm_attr_levels)
 export(ergm_bd_init)
+export(ergm_conlist)
 export(ergm_cutoff_message)
 export(ergm_dyadgen_select)
 export(ergm_edgecov_args)

R/ergm_proposal.R

@@ -243,44 +243,38 @@ ergm_proposal.character <- function(object, arguments, nw, ..., reference=ergm_r
 }
 
 
-
-
-
-########################################################################################
-# The <ergm_proposal.formula> function verifies that the given constraints exist and
-# are supported in conjuction with the given weights and class by a unique proposal;
-# if so the ergm_proposal object is created via <ergm_proposal.character> using the 
-# proposal type found in the look-up table above.
-#
-# --PARAMETERS--
-#   object     :  a one-sided formula of constraint terms ( ~ term(s))
-#   arguments  :  a list of parameters used by the <InitErgmProposal> routines  possibly including
-#                  bd: a list of parameters used to bound degree via <ergm.bounddeg>
-#   nw         :  a network object
-#   constraints:  the constraints as a one sided formula '~ term(s)'
-#   weights    :  specifies the method used to allocate probabilities of being proposed
-#                 to dyads; options are "TNT", "StratTNT", "TNT10", "random", "nonobserved" and
-#                 "default"; default="default"
-#   class      :  the class of the proposal; choices include "c", "f", and "d"
-#                 default="c"
-#
-########################################################################################
-
-#' @noRd
+#' Internal representation of ERGM sample space constraints and hints
+#'
+#' See [`ergmConstraint`] for details on specifying proposals and
+#' constraints.
+#'
+#' @param object a data type
+#'
+#' @keywords internal
+#' @export
 ergm_conlist <- function(object, ...) UseMethod("ergm_conlist")
 
-#' @noRd
+#' @describeIn ergm_conlist identity method.
+#' @export
 ergm_conlist.ergm_conlist <- function(object, ...) object
 
-#' @noRd
+#' @describeIn ergm_conlist handling for `NULL`, to simplify other code.
+#' @export
 ergm_conlist.NULL <- function(object, ...) NULL
 
-#' @noRd
-ergm_conlist.formula <- function(object, nw, ..., term.options=list())
-  object %>% .embed_constraint_lhs() %>% list_rhs.formula() %>%
-    ergm_conlist(nw, ..., term.options=term.options)
+#' @describeIn ergm_conlist initialize from [`formula`], such as in
+#'   [ergm()] `constraints` and `obs.constraints` arguments: preserve
+#'   the LHS, convert to [`term_list`], and use the nxt method.
+#'
+#' @param nw a [`network`] object.
+#' @template term_options
+#'
+#' @export
+ergm_conlist.formula <- function(object, nw, ...)
+  object |> .embed_constraint_lhs() |> list_rhs.formula() |> ergm_conlist(nw, ...)
 
-#' @noRd
+#' @describeIn ergm_conlist initialize from [`term_list`].
+#' @export
 ergm_conlist.term_list <- function(object, nw, ..., term.options=list()){
   object <-
     if(is(object, "AsIs")) structure(object, class = class(object)[class(object) != "AsIs"])
@@ -309,10 +303,12 @@ ergm_conlist.term_list <- function(object, nw, ..., term.options=list()){
   prune.ergm_conlist(conlist)
 }
 
-#' @noRd
+#' @describeIn ergm_conlist a concatenation method.
+#' @export
 c.ergm_conlist <- function(...) NextMethod() %>% prune.ergm_conlist()
 
-#' @noRd
+#' @describeIn ergm_conlist a subsetting method.
+#' @export
 `[.ergm_conlist` <- function(x, ...){
   structure(NextMethod(), class = "ergm_conlist")
 }