RSGInc / RSGHB

Functions for Hierarchical Bayesian Estimation: A Flexible Approach
Other
25 stars 16 forks source link

Simplify control argument names #76

Open jeffkeller87 opened 8 years ago

jeffkeller87 commented 8 years ago

Control argument names are outdated, occasionally inconsistent, and confusing (particularly the "normal" and "fixed" nomenclature). I've set the HBControl function up to easily catch deprecated arguments and direct users to new usages/names. I don't think this is a pressing issue at all, but wanted to get my thoughts down before I lose them.

Below are my suggestions: currentName (proposedName)

jeffkeller87 commented 8 years ago

Makes sense to me to combine FC+gVarNamesFixed and svN+gVarNamesNormal into two numeric vectors with optional names to simplify things.

E.g. c(beta_price = 0, beta_time = -0.5)

This is related to issue #75.

ghost commented 8 years ago

How about?

On Tue, Mar 15, 2016 at 11:48 PM, Jeff Keller notifications@github.com wrote:

Control argument names are outdated, occasionally inconsistent, and confusing (particularly the "normal" and "fixed" nomenclature). I've set the HBControl function up to easily catch deprecated arguments and direct users to new usages/names. I don't think this is a pressing issue at all, but wanted to get my thoughts down before I lose them.

Below are my suggestions: currentName (proposedName)

  • gVarNamesNormal (???)
  • gVarNamesFixed (???)
  • gDIST (dist)
  • FC (???)
  • svN (???)
  • gNCREP (???)
  • gNEREP (???)
  • gNSKIP (skip)
  • gINFOSKIP (trace)
  • priorVariance (pv)
  • degreesOfFreedom (df)
  • constraintsNorm (???)
  • rho/rhoF (???)
  • targetAcceptanceNormal (???)
  • targetAcceptanceFixed (???)
  • gFULLCV (???)
  • gStoreDraws (keep.draws)
  • gSeed (seed)
  • gMINCOEF (???)
  • gMAXCOEF (???)
  • nodiagnostics (diagnostics; invert to avoid double negative)

— You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub https://github.com/RSGInc/RSGHB/issues/76

jeffkeller87 commented 8 years ago

I like these. What do you think about combining par.random.sv/.names and par.fixed.sv/.names down to par.random and par.fixed (optionally named)?

ghost commented 8 years ago

That is okay with me.

On Wed, Mar 16, 2016 at 1:47 PM, Jeff Keller notifications@github.com wrote:

I like these. What do you think about combining par.random.sv/.names and par.fixed.sv/.names down to par.random and par.fixed (optionally named)?

— You are receiving this because you commented. Reply to this email directly or view it on GitHub https://github.com/RSGInc/RSGHB/issues/76#issuecomment-197454609