statnet / tergm

Fit, Simulate and Diagnose Models for Network Evolution Based on Exponential-Family Random Graph Models

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

for simulate.tergm, consider renaming stats and monitor outputs

martinamorris opened this issue · comments

currently when both "stats" and "monitor" are called, two elements are returned as attributes of the output object (or as a list if output="stats"):

stats.gen for the "stats" and

stats for the "monitored" stats.

that's a bit confusing. it would be helpful to name them with simple, clearer extensions.

stats -> stats.monitor, and

stats.gen -> stats.model or stats.terms

I guess stats.model and stats.monitor sound OK. I'll add them on and retain the old names for backwards compatibility. We'll figure out later how to deprecate them.

I think I'll make it stats$model and stats$monitor: so stats is a list with two elements.

fwiw changing stats from a matrix to a list of matrices is not backwards-compatible, and breaks EpiModel in particular

fwiw changing stats from a matrix to a list of matrices is not backwards-compatible, and breaks EpiModel in particular

Given that, for backwards compatibility, we probably need to keep stats and stats.gen as well, at least for a while.

Anyway, this is for the next release.