Clean up documentation - Githubissues

nk027 / bvar

Toolkit for the estimation of hierarchical Bayesian vector autoregressions. Implements hierarchical prior selection for conjugate priors in the fashion of Giannone, Lenza & Primiceri (2015). Allows for the computation of impulse responses and forecasts and provides functionality for assessing results.

https://cran.r-project.org/package=BVAR

Other

47 stars 19 forks source link

Clean up documentation #51

Closed nk027 closed 4 years ago

nk027 commented 4 years ago

There's a lot to do to improve the docs:

Document:

new plotting features from #41
transformed FRED-QD from #43

Also:

merge some related functionalities
give better names to items
rework keywords
more examples (also see #39)
improve formatting

nk027 commented 4 years ago

Done:

Documented new plotting
Documented new FRED
Remove unnecessary method docs
Small fixes
Changed some names

To-do:

Rework keywords
Go through text of the documentation
Re-work examples

nk027 commented 4 years ago

Ok so as of 8af2216 I'd say the only pressing issue is reworking the keywords a bit.

There we should focus on grouping related stuff and making the package searchable.

oDNAudio commented 4 years ago

One thing we might wanna change is the wording regarding the ML. Now it is called marginalised likelihood in all prints and documentations. We should align this with the text in the paper.