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

for simulate.tergm, consider renaming stats and monitor outputs #66

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

Comments

@martinamorris
Copy link
Member

martinamorris commented Jun 24, 2021

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

@martinamorris martinamorris changed the title for simulate.tergm, consider renaming "stats" to "stats.monitor", and "stats.gen" to "stats.model" for simulate.tergm, consider renaming stats and monitor outputs Jun 24, 2021
@krivit
Copy link
Member

krivit commented Jun 12, 2022

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.

@krivit
Copy link
Member

krivit commented Jun 12, 2022

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

krivit added a commit that referenced this issue Jun 12, 2022
krivit added a commit that referenced this issue Jun 12, 2022
@chad-klumb
Copy link
Contributor

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

@krivit
Copy link
Member

krivit commented Jun 22, 2022

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.

krivit added a commit that referenced this issue Jun 22, 2022
@krivit
Copy link
Member

krivit commented Jun 22, 2022

Anyway, this is for the next release.

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