Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update documentation for simulate.tergm #65

Open
martinamorris opened this issue Jun 24, 2021 · 4 comments
Open

update documentation for simulate.tergm #65

martinamorris opened this issue Jun 24, 2021 · 4 comments

Comments

@martinamorris
Copy link
Member

as currently written, it appears to assume STERGM. for example:

tergm/R/simulate.tergm.R

Lines 67 to 71 in 3080520

#' @param monitor A one-sided formula specifying one or more terms whose
#' value is to be monitored. If \code{monitor} is specified as a character
#' (one of \code{"formation"}, \code{"dissolution"}, and \code{"all"}) then
#' the function \code{\link{.extract.fd.formulae}} is used to determine the
#' corresponding formula; the user should be aware of its behavior and limitations.

if the monitor argument can only be used with Form() and Diss() operators, we should say this, otherwise this needs to be rewritten.

@krivit
Copy link
Member

krivit commented Jun 24, 2021

It can be used with all of them, I think.

@martinamorris
Copy link
Member Author

martinamorris commented Jun 24, 2021

And where do the monitored stats live in the output object?

I just ran the sim below, and I can see the stats.gen but not the monitored stats:

sep.sim <- simulate(sep.fit, nsim = 1, 
                    time.slices = 1000, 
                    monitor = "~edges",
                    stats = T)
names(attributes(sep.sim))
[1] "names"     "class"     "stats.gen" "coef"      "changes" 
``

@krivit
Copy link
Member

krivit commented Jun 24, 2021

Appended to stats, wherever they are.

@chad-klumb
Copy link
Contributor

monitor should be either an ordinary formula (so, ~edges, not "~edges") or one of the character values "formation", "dissolution", or "all"

I think the character options should be removed (we can't make sense of them in the general non-separable case) but at the moment they are still there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants