-
Notifications
You must be signed in to change notification settings - Fork 48
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
Markdown show methods for our types #474
Conversation
Codecov Report
@@ Coverage Diff @@
## master #474 +/- ##
==========================================
+ Coverage 92.84% 93.49% +0.65%
==========================================
Files 26 27 +1
Lines 1746 1906 +160
==========================================
+ Hits 1621 1782 +161
+ Misses 125 124 -1
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks fine to me. Thanks very much for doing this - formatting output is one of my least favorite parts of coding - probably tracing back to needing to write Fortran FORMAT statements in my youth.
* specify plain-text MIME in show methods * remove redudant method * markdown show method for VarCorr * show md blockdescription * broaden size to work on GLMM * show md method for MixedModel * show method for LikelihoodRatioTest * NEWS entry * remove unused padding computation * more usage notes * not gonna PCA afterall * remove unused and problematic digits kwarg * optsummary * tests * disable BLAS info on 1.7 * better plain-text readability of markdown for MixedModel, BlockDescription * force a particular model fit in tests * fix future guard * more forcing fit results for textual comparison * helps if you save your changes * format tweak * whyyyy * variability in printing exponent (cherry picked from commit f81ccbc)
* Markdown show methods for our types (#474) * specify plain-text MIME in show methods * remove redudant method * markdown show method for VarCorr * show md blockdescription * broaden size to work on GLMM * show md method for MixedModel * show method for LikelihoodRatioTest * NEWS entry * remove unused padding computation * more usage notes * not gonna PCA afterall * remove unused and problematic digits kwarg * optsummary * tests * disable BLAS info on 1.7 * better plain-text readability of markdown for MixedModel, BlockDescription * force a particular model fit in tests * fix future guard * more forcing fit results for textual comparison * helps if you save your changes * format tweak * whyyyy * variability in printing exponent (cherry picked from commit f81ccbc) * version bump
Closes #273.
Needs tests.I've marked this for v3.2 in the NEWS file and will do the necessary backport as soon as this is merged.
There's no method for
CoefTable
because that would be type piracy. I'll make an upstream PR.The Markdown tables for the models are compact. This is intentional -- I think this is journal/publication friendlier and also makes them true Markdown tables. If we decide to add in LaTeX methods, this will also be convenient. The measures of fit (log likelihood, deviance, AIC, BIC) can be extracted separately and if someone really wants to fight with a journal, then they can assemble the pieces from the
VarCorr
andCoefTable
methods.OptSummary
was low-hanging fruit, so I've included it.PCA
seems fiddly won't be a single table anyway, so I've omitted it. (I also don't expect most people to include that in published work, so it really didn't seem like the effort.)BlockDescription
LikelihoodRatioTest
MixedModel
OptSummary
LN_BOBYQA
Lower bounds
ftol_rel
ftol_abs
xtol_rel
xtol_abs
initial_step
maxfeval
FTOL_REACHED
VarCorr