Skip to content

Commit

Permalink
Updated parallel controls documentation template.
Browse files Browse the repository at this point in the history
  • Loading branch information
krivit committed Oct 8, 2024
1 parent b7bec4e commit a57dd06
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 44 deletions.
18 changes: 9 additions & 9 deletions man-roxygen/control_MCMC_parallel.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
# Copyright 2003-2024 Statnet Commons
################################################################################
#' @param parallel Number of threads in which to run the sampling. Defaults to
#' 0 (no parallelism). See the entry on [parallel processing][ergm-parallel]
#' for details and troubleshooting.
#' @param parallel.type API to use for parallel processing. Supported values
#' are \code{"MPI"} and \code{"PSOCK"}. Defaults to using the \code{parallel}
#' package with PSOCK clusters. See \code{\link{ergm-parallel}}
#' @param parallel.version.check Logical: If TRUE, check that the version of
#' \pkg{ergm} running on the slave nodes is the same as
#' that running on the master node.
#' 0 (no parallelism). See [`ergm-parallel`]
#' for details and troubleshooting.
#' @param parallel.type API to use for parallel processing. Defaults
#' to using the \pkg{parallel} package with PSOCK clusters. See
#' [`ergm-parallel`].
#' @param parallel.version.check Logical: If TRUE, check that the
#' version of \CRANpkg{ergm} running on the slave
#' nodes is the same as that running on the master node.
#' @param parallel.inherit.MT Logical: If TRUE, slave nodes and
#' processes inherit the [set.MT_terms()] setting.
#' processes inherit the [set.MT_terms()] setting.
14 changes: 7 additions & 7 deletions man/control.ergm.Rd

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

14 changes: 7 additions & 7 deletions man/control.ergm.bridge.Rd

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

14 changes: 7 additions & 7 deletions man/control.gof.Rd

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

14 changes: 7 additions & 7 deletions man/control.san.Rd

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

14 changes: 7 additions & 7 deletions man/control.simulate.ergm.Rd

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

0 comments on commit a57dd06

Please sign in to comment.