Skip to content

Commit

Permalink
Documentation fixes to mcmc.diagnostics().
Browse files Browse the repository at this point in the history
  • Loading branch information
krivit committed Oct 7, 2024
1 parent 90796aa commit 8d51b04
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 19 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: ergm
Version: 4.7-7420
Version: 4.7-7421
Date: 2024-10-07
Title: Fit, Simulate and Diagnose Exponential-Family Models for Networks
Authors@R: c(
Expand Down
17 changes: 8 additions & 9 deletions R/mcmc.diagnostics.ergm.R
Original file line number Diff line number Diff line change
Expand Up @@ -85,20 +85,19 @@ mcmc.diagnostics.default <- function(object, ...) {
#' observed network statistics. For that functionality, please use
#' the GOF command: \code{gof(object, GOF=~model)}.
#'
#' In fact, an ergm output \code{object} contains the matrix of
#' statistics from the MCMC run as component \code{$sample}. This
#' matrix is actually an object of class \code{mcmc} and can be used
#' directly in the \code{coda} package to assess MCMC
#' convergence. \emph{Hence all MCMC diagnostic methods available in
#' \code{coda} are available directly.} See the examples and
#' \url{https://www.mrc-bsu.cam.ac.uk/software/bugs/the-bugs-project-winbugs/coda-readme/}.
#' In fact, an [ergm()] output object contains the sample of
#' statistics from the last MCMC run as element `$sample`. If
#' missing data MLE is fit, the corresponding element is named
#' `$sample.obs`. These are objects of [`mcmc`] and can be used
#' directly in the \CRANpkg{coda} package to assess MCMC
#' convergence.
#'
#' More information can be found by looking at the documentation of
#' [ergm()].
#'
#' @param center Logical: If TRUE, center the samples on the observed
#' @param center Logical: If `TRUE`, center the samples on the observed
#' statistics.
#' @param esteq Logical: If TRUE, for statistics corresponding to
#' @param esteq Logical: If `TRUE`, for statistics corresponding to
#' curved ERGM terms, summarize the curved statistics by their
#' negated estimating function values (evaluated at the MLE of any curved
#' parameters) (i.e., \eqn{\eta'_{I}(\hat{\theta})\cdot (g_{I}(Y)-g_{I}(y))}
Expand Down
17 changes: 8 additions & 9 deletions man/mcmc.diagnostics.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8d51b04

Please sign in to comment.