Added examples of directly specifying values in levels2=.

references #563
statnet · Sep 29, 2024 · 1afa77d · 1afa77d
1 parent b7751de
commit 1afa77d
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/R/get.node.attr.R b/R/get.node.attr.R
@@ -231,6 +231,12 @@ get.node.attr <- function(nw, attrname, functionname=NULL, numeric=FALSE) {
 #' # Select via an index of a cell:
 #' idx <- cbind(1,2)
 #' summary(faux.mesa.high~mm("Sex", levels2=idx))
+#' # Or, select by specific attribute value combinations, though note
+#' # the names 'row' and 'col' and the order for undirected networks:
+#' summary(faux.mesa.high~mm("Sex",
+#'                           levels2 = I(list(list(row="M",col="M"),
+#'                                            list(row="M",col="F"),
+#'                                            list(row="F",col="M")))))
 #'
 #' # mm() term allows two-sided attribute formulas with different attributes:
 #' summary(faux.mesa.high~mm(Grade~Race, levels2=TRUE))

diff --git a/man/nodal_attributes.Rd b/man/nodal_attributes.Rd
diff --git a/vignettes/nodal_attributes.Rmd b/vignettes/nodal_attributes.Rmd
@@ -192,6 +192,12 @@ summary(faux.mesa.high~mm("Sex", levels2=M)+mm("Sex", levels2=t(M)))
 # Select via an index of a cell:
 idx <- cbind(1,2)
 summary(faux.mesa.high~mm("Sex", levels2=idx))
+# Or, select by specific attribute value combinations, though note the
+# names 'row' and 'col' and the order for undirected networks:
+summary(faux.mesa.high~mm("Sex",
+                          levels2 = I(list(list(row="M",col="M"),
+                                           list(row="M",col="F"),
+                                           list(row="F",col="M")))))
 ```
 
 The attributes of the `mm()` term can be a two-sided formula with different attributes: