statnet / ergm

Fit, Simulate and Diagnose Exponential-Family Models for Networks
Other
95 stars 37 forks source link

Harmonise the name of the "hint" in the c_ and u_ functions. #250

Closed krivit closed 3 years ago

krivit commented 3 years ago

A c and a u function in the new API currently gets the following arguments:

For consistency, it would be helpful to have the last argument---the "hint" about the current presence indicator / weight---had the same argument name. There has been some discussion, which was tabled until the code was merged, so the time is now to make the change. Some possible replacements for edgeflag/edgeweight:

Any other ideas or preferences? @mbojan @drh20drh20 @chad-klumb @handcock @sgoodreau @CarterButts

krivit commented 3 years ago

This follows up from https://github.com/statnet/ergm-private/issues/261 .

krivit commented 3 years ago

What about edgenow? It's shorter than status...

krivit commented 3 years ago

edgestate is another slightly shorter option.

martinamorris commented 3 years ago

that seems like a good choice

krivit commented 3 years ago

It's trivial to change (since it's a search-and-replace of a unique string), so I'll go with it for now.

krivit commented 3 years ago

@drh20drh20 suggested edgeval.

krivit commented 3 years ago

In the end, I am going with edgestate: edgeval is shorter, but it feels ambiguous in that it's not necessarily the current value; edgehint is also shorter, but it's vague.

krivit commented 3 years ago

@smjenness , @ifellows , both EpiModel and lolog link to ergm. If those packages don't define any new-style (c_ and u_) statistics, they should not be affected---and as far as I can tell, they don't---but I want to flag this to avert surprises.