ergm icon indicating copy to clipboard operation
ergm copied to clipboard

Published 20 hours ago • verified publisher icon statnet

Triage inaccessible, undocumented, and/or unused proposals and decide which to fix and which to remove

Open krivit opened this issue 3 years ago • 2 comments

A number of proposals have accumulated, particularly in the C code, many of which are one or more of the following:

  • is inaccessible: there is no Init*ErgmProposal.*() function that references them
  • uses defunct APIs (e.g., #287)
  • is not in the proposal lookup table (or, more precisely, none of the Init*ErgmProposal.*() functions that reference it are)
  • is untested in examples or tests (e.g., according to https://app.codecov.io/gh/statnet/ergm)

Some need to be salvaged, others removed. I have compiled what I am pretty sure is all the proposal functions we have and created a checklist for each of them. @drh20drh20 , @handcock , @CarterButts , you are probably the only ones who remember how and why some of these ended up in the package, and whether or not they still have any value. If you could take a minute to go through the list and tell me if any of these are no longer worth keeping, that would save a lot of time.

Edit: It appears that the checklists in the table isn't working as expected. Here they are in a flat list. Apologies for the length.

BipartiteHammingConstantEdges

  • [ ] Does not use defunct APIs
  • [x] Is accessible from R
  • [x] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

BipartiteHammingTNT

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

BipartiteCondDegreeDist

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

randomtoggle

  • [x] Does not use defunct APIs
  • [x] Is accessible from R
  • [x] Is in the lookup table
  • [ ] Is tested
  • [x] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

TNT

  • [x] Does not use defunct APIs
  • [x] Is accessible from R
  • [x] Is in the lookup table
  • [x] Is tested
  • [x] Resolve: Keep
  • [ ] Resolve: Remove
  • [x] Resolved

BDStratTNT

  • [x] Does not use defunct APIs
  • [x] Is accessible from R
  • [x] Is in the lookup table
  • [x] Is tested
  • [x] Resolve: Keep
  • [ ] Resolve: Remove
  • [x] Resolved

TNT10

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

ConstantEdges

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondDegreeDist

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondOutDegreeDist

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondInDegreeDist

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

TwoRandomToggles

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

randomnode

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

ConstrainedCondOutDegDist

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

NodePairedTiesToggles

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

OneRandomTnTNode

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

ReallocateWithReplacement

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

AllTogglesForOneNode

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

SwitchLabelTwoNodesToggles

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

ConstrainedCondDeg

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

ConstrainedSwitchLabelTwoNodesToggles

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

ConstrainedCondDegDist

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

ConstrainedNodePairedTiesToggles

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

ConstrainedReallocateWithReplacement

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

ConstrainedAllTogglesForOneNode

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

ConstrainedTwoRandomToggles

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

ConstantEdgesToggles

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondDegSwitchToggles

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondDegreeTetrad

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondDegreeMix

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondDegreeTetradMixMore

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondDegreeTetradMixLess

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondDegreeMixChangeOrig

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondDegreeMix

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondDegreeHexad

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondDegree

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondOutDegree

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondInDegree

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondB1Degree

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

CondB2Degree

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

dyadnoiseTNT

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

dyadnoisemTNT

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

dyadnoise

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

dyadnoisem

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

StdNormal

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

Unif

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

UnifNonObserved

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

DiscUnif

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

DiscUnif2

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

DiscUnifNonObserved

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

DistRLE

  • [ ] Does not use defunct APIs
  • [ ] Is accessible from R
  • [ ] Is in the lookup table
  • [ ] Is tested
  • [ ] Resolve: Keep
  • [ ] Resolve: Remove
  • [ ] Resolved

krivit avatar May 05 '21 13:05 krivit

P.S. @handcock , @drh20drh20 , @CarterButts , @mbojan , @chad-klumb , if you know the status of any of these off the top of your head (e.g., you wrote the test or you use it regularly) please take a moment to tick the corresponding boxes.

krivit avatar May 05 '21 13:05 krivit

I checked the one I wrote (BDStratTNT), and don't know much about the others.

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