tergm icon indicating copy to clipboard operation
tergm copied to clipboard

update documentation for simulate.tergm

Open martinamorris opened this issue 3 years ago • 4 comments

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

https://github.com/statnet/tergm/blob/3080520c3078d903d2c8b2fef749afbf6109f556/R/simulate.tergm.R#L67-L71

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

martinamorris avatar Jun 24 '21 00:06 martinamorris

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

krivit avatar Jun 24 '21 00:06 krivit

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" 
``

martinamorris avatar Jun 24 '21 00:06 martinamorris

Appended to stats, wherever they are.

krivit avatar Jun 24 '21 01:06 krivit

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.

chad-klumb avatar Jun 24 '21 01:06 chad-klumb