Deprecated and Removed Functions in dbarts
dbarts-deprecated.RdNames kept reachable for one release past their removal or rename, each pointing at its successor. They are removed in dbarts 1.1-0.
bart2 is the former name of the modern front door, which is now bart; a bart2 call is forwarded, with a warning the first time in a session. Its one default that differs from bart's is combineChains = FALSE, as in 0.9-34's bart2, so a multi-chain fit keeps its chains as a margin of its draws. The fit's stored call is the bart2 call as written.
rbart_vi and its methods are deprecated, and documented on rbart_vi.
Details
The rest of the registry is names still reachable on entry points that keep their own page, rather than functions of their own: each is accepted for one release, mapped onto its successor with a once-per-session warning of class dbartsDeprecatedWarning, which inherits dbartsWarning (or refused by name, where noted), and removed in dbarts 1.1-0.
rngSeedOn
bartanddbartsControl: the engine seed, nowseed.sigmaOn
dbartsandxbart: the creation-time residual estimate, nowsigest; likesigest, it defaults toNULL.node.priorOn
dbarts: the leaf-value prior, nowleaf.prior.degreesOfFreedomOn
dbartsPriors'schi(): the degrees of freedom of the hyperprior onk, nowdf, asinvchi()and base R'sdchisqspell it. Positional calls,chi(1.5, 2), are unchanged.tree.priorOn
dbartsanddbartsSpec: the tree prior, nowpower,baseandsplit.probs, asbarttakes them (tree.prior = cgm(power, base, split.probs)ispower,baseandsplit.probs, andtree.prior = dart(a, b)issplit.probs = dart(a, b)). A tree prior object saved by 0.9-34 is read the same way. The value is used, with a once-per-session warning.bartandxbartnever took it and refuse it, naming the plain spelling.resid.prior,sigdf,sigquantThe residual scale's prior is a setting of the families that draw one, so it rides the family object (
family = gaussian(sigma = chisq(df, quant)),family = gaussian(sigma = fixed(value))); likewisestudent(df, sigma = ),aft(sigma = )andhurdle.lognormal(sigma = ).sigdfandsigquantare retired onbart;resid.prioris retired the same way onbart,dbartsandxbart, anddbartsSpecrefuses it, so the prior has one home on every door. A call that writes it both ways - a retired spelling and a family whose call namedsigma- is refused where the two disagree.sigest, the residual-scale estimate supplied at creation, is unaffected.proposal.probsOn
bartanddbarts: the tree-move mixture, now adbartsControlslot and formal (control = dbartsControl(proposal.probs = )).n.trees,n.cuts,useQuantilesondbartsControlWhat a model and its data hold:
n.treesis now an argument ofdbarts,dbartsSpecandforest, andn.cutsanduseQuantilesofdbartsanddbartsData. A value written on a control is read after a once-per-session warning; a control's value that differs from what a call takes draws a warning on every call, and a value a fit left on its control states nothing.sigestbeside a fixed residual scaleA fit that states
sigestand a residual scale held fixed (family = gaussian(sigma = fixed(value))) runs,sigesthaving no effect, after a once-per-session warning; it is an error from dbarts 1.1-0, so dropsigest.- The
n.trees,useQuantilesandbinaryslots of adbartsControlobject Still readable, as
control@n.trees,control@useQuantilesandcontrol@binary, for code that reads them from the control; the values now live on the model and the data: the forests' tree counts in the model'sforests,useQuantilesin the data object'suseQuantilesslot, and the response family in the model'sfamilyslot. A later release removes them.- A three-element
n.burnonxbart Refused outright, naming
n.burn = c(fresh, warm): 0.9-x's third element was a per-replication burn-in, and a chain is never carried between replications now.dbartsSampler's$startThreads/$stopThreadsNo-op methods (
dbartsSampler): the hierarchical thread manager they drove is gone, threads now owned per run, but a 0.9-x Gibbs loop that brackets its sweeps with them still runs.dbartsSampler's$sampleNodeParametersFromPriorForwarded to
$sampleLeafParametersFromPrior(dbartsSampler) after a once-per-session warning.- A thread count on
dbartsSampler's$run Ignored after a once-per-session warning, whether passed as
n.threads, as 0.9-x's formalnumThreads, or positionally afterupdateState: a run uses the sampler's own count, which$setControlchanges, and its draws do not depend on it.- A logical
updateCutPointsondbartsSampler's$setPredictor Read after a once-per-session warning,
TRUEas"position"andFALSEas"none": the argument is now one of"none","position"and"value"(dbartsSampler), and"position"is whatTRUEdid.NAwhereNULLnow means not givenNULL, notNA, is the one spelling of an absent value. Where 0.9-34's own default wasNA, an explicitNAis still read asNULLafter a once-per-session warning:sigestonbart;seedonbart,bartBTandxbart;n.samplesondbartsControl;updateStateon thedbartsSamplermethods andupdatePredictorPerObservationJointly; andnumBurnInandnumSampleson$run. An argument new in 1.0-0 refuses anNA, namingNULL:sigestandseedondbarts,sigestonxbart,seedondbartsControl, and both ondbartsSpec, which is new, andseedondbartsValidateComposition.- A BayesTree-spelled
bartcall Forwarded to
bartBTafter a once-per-session warning, when the call carries a name frombartBT's own formals thatbartdoes not take. A call that also names an argumentbartBTdoes not take (data,n.samples, any modern spelling) fits under neither and is refused before it is forwarded, naming the BayesTree names given with their modern spellings and the others.- A fourth or later positional
bartargument Refused, naming both doors: 0.9-x's
bartread a fourth positional argument assigest, wherebart's own fourth formal issubset.- The front-door startup message
Attaching the package prints one
packageStartupMessagenaming both doors, once per session (suppressPackageStartupMessagessilences it); no successor, since nothing replaces it.- The front-door defaults message
A
bartcall that names nobartBTargument and whose first argument is not a formula - a 0.9-x call such asbart(x.train, y.train, x.test)- binds the same way under both doors, so nothing forwards it and it runs underbart's own defaults. The first such call in a session prints a message of classdbartsFrontDoorMessagenaming the change andbartBT;suppressMessagessilences it, and a call made from package code prints nothing.- A BayesTree-spelled
pdbartorpd2bartcall Each name
bartBTtakes andbartdoes not is translated tobart's spelling, after a once-per-session warning per name and function that also fires for a call from package code;x.testandsampleronlyare refused. A setting given under both spellings is refused.- The pdbart defaults message
The first
pdbartorpd2bartcall in a session that fits data and names no BayesTree argument prints a message of classdbartsFrontDoorMessagesaying that the fit usesbart's defaults and thatpdbart(bartBT(x, y, keeptrees = TRUE))gives the 0.9-34 model; a call made from package code prints nothing.
Every entry above, bart2 and rbart_vi, is one row of dbarts:::dbartsTombstones, the registry this page documents by hand.
Value
bart2 returns what bart returns, with the chains separate unless combineChains = TRUE is given.