From 211c389bb6ed5a799ea9b5cb1f3ce37dd3e69d19 Mon Sep 17 00:00:00 2001 From: "Pavel N. Krivitsky" Date: Tue, 13 Aug 2024 15:34:14 +1000 Subject: [PATCH] Fixed up some documentation warnings. --- DESCRIPTION | 4 ++-- R/InitErgmProposal.DynMoME.R | 4 ++-- inst/NEWS.Rd | 2 +- man/discordBDStratTNT-ergmProposal-9267ec8b.Rd | 2 +- man/discordTNT-ergmProposal-bc75dff0.Rd | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 0458817e..7ec82be0 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: tergm -Version: 4.2-2547 -Date: 2024-05-26 +Version: 4.2-2559 +Date: 2024-08-13 Title: Fit, Simulate and Diagnose Models for Network Evolution Based on Exponential-Family Random Graph Models Authors@R: c( person(c("Pavel", "N."), "Krivitsky", role=c("aut","cre"), email="pavel@statnet.org", comment=c(ORCID="0000-0002-9101-3362")), diff --git a/R/InitErgmProposal.DynMoME.R b/R/InitErgmProposal.DynMoME.R index 4093f24f..99cfd087 100644 --- a/R/InitErgmProposal.DynMoME.R +++ b/R/InitErgmProposal.DynMoME.R @@ -12,7 +12,7 @@ #' @aliases InitErgmProposal.discordTNT #' @title Temperal TNT proposal #' @description A temporal version of \code{\link[ergm:TNT-ergmProposal]{TNT}}, with approximately -#' code{discordance_fraction} of proposed toggles being made on the set of discordant dyads, +#' \code{discordance_fraction} of proposed toggles being made on the set of discordant dyads, #' approximately \code{1 - discordance_fraction} of proposed toggles being TNT proposals from #' network. The value of \code{discordance_fraction} can be set by the user as a proposal argument, #' defaults to `0.5`. @@ -42,7 +42,7 @@ InitErgmProposal.discordTNT <- function(arguments, nw, ...) { #' #' arguments are the same as for \code{\link[ergm:BDStratTNT-ergmProposal]{BDStratTNT}}, #' and should be passed in via the \code{\link[ergm:bd-ergmConstraint]{bd}} and -#' code{\link[ergm:blocks-ergmConstraint]{blocks}} constraints and +#' \code{\link[ergm:blocks-ergmConstraint]{blocks}} constraints and #' \code{\link[ergm:strat-ergmHint]{strat}} hint. #' @template ergmProposal-general NULL diff --git a/inst/NEWS.Rd b/inst/NEWS.Rd index 13974c60..b97af899 100644 --- a/inst/NEWS.Rd +++ b/inst/NEWS.Rd @@ -424,7 +424,7 @@ If set to "zeros", the initial values are set to zeros. \item \code{SA.oh.memory = 100000} Absolute maximum number of data points per thread to store in the full optimization history. } - \item Changes to \code{simulate.stergm} parameters: addition of \code{duration.dependent} parameter: {Logical: Whether the model terms in formula or model are duration dependent. E.g., if a duration-dependent term is used in estimation/simulation model, the probability of forming or dissolving a tie may dependent on the age the dyad status. If TRUE, the matrix of tie ages will be allocated.} + \item Changes to \code{simulate.stergm} parameters: addition of \code{duration.dependent} parameter to control whether the model terms in formula or model are duration dependent. E.g., if a duration-dependent term is used in estimation/simulation model, the probability of forming or dissolving a tie may dependent on the age the dyad status. } } diff --git a/man/discordBDStratTNT-ergmProposal-9267ec8b.Rd b/man/discordBDStratTNT-ergmProposal-9267ec8b.Rd index fd6ff8a2..82dffd14 100644 --- a/man/discordBDStratTNT-ergmProposal-9267ec8b.Rd +++ b/man/discordBDStratTNT-ergmProposal-9267ec8b.Rd @@ -15,7 +15,7 @@ rather than the temporal operator networks). arguments are the same as for \code{\link[ergm:BDStratTNT-ergmProposal]{BDStratTNT}}, and should be passed in via the \code{\link[ergm:bd-ergmConstraint]{bd}} and -code{\link[ergm:blocks-ergmConstraint]{blocks}} constraints and +\code{\link[ergm:blocks-ergmConstraint]{blocks}} constraints and \code{\link[ergm:strat-ergmHint]{strat}} hint. } \details{ diff --git a/man/discordTNT-ergmProposal-bc75dff0.Rd b/man/discordTNT-ergmProposal-bc75dff0.Rd index d50b93d7..8b652d46 100644 --- a/man/discordTNT-ergmProposal-bc75dff0.Rd +++ b/man/discordTNT-ergmProposal-bc75dff0.Rd @@ -6,7 +6,7 @@ \title{Temperal TNT proposal} \description{ A temporal version of \code{\link[ergm:TNT-ergmProposal]{TNT}}, with approximately -code{discordance_fraction} of proposed toggles being made on the set of discordant dyads, +\code{discordance_fraction} of proposed toggles being made on the set of discordant dyads, approximately \code{1 - discordance_fraction} of proposed toggles being TNT proposals from network. The value of \code{discordance_fraction} can be set by the user as a proposal argument, defaults to \code{0.5}.