Need help in adding "See also" section - Plots

[roshnaeem]

Short Description

For adding a "See also" section in docstrings, I need help to be sure about which functions should be added in this section for each function.

Code Example or link

An example of the "See also" section can be found at compare page.

Related to https://github.com/arviz-devs/arviz/issues/1188

Relevant documentation or public examples

I am adding the list of functions here. Comment your suggestions here for the "see also" section of these functions. I'll keep updating the list here so in case if someone has already commented for one function, there won't be an extra effort.

Functions List

• [x] arviz.plot_autocorr
• [x] arviz.plot_bpv
• [x] arviz. plot_compare
• [x] arviz. plot_density
• [x] arviz. plot_dist
• [x] arviz. plot_dist_comparison
• [x] arviz. plot_dot
• [x] arviz. plot_elpd
• [x] arviz. plot_energy
• [x] arviz. plot_ess
• [x] arviz. plot_forest
• [x] arviz. plot_hdi
• [x] arviz. plot_joint
• [x] arviz.plot_kde
• [x] arviz.plot_khat
• [x] arviz.plot_loo_pit
• [x] arviz.plot_lm
• [x] arviz.plot_mcse
• [x] arviz.plot_pair
• [x] arviz.plot_parallel
• [x] arviz.plot_posterior
• [x] arviz.plot_ppc
• [x] arviz.plot_rank
• [x] arviz.plot_separation
• [x] arviz.plot_trace
• [x] arviz.plot_ts
• [x] arviz.plot_violin

[OriolAbril]

Some ideas:

• plot_autocorr should link tot autocorr and autocov
• plot_bvp should link to plot_ppc, plot_loo_pit, and plot_dist_comparison
• plot_compare should link to compare, plot_elpd, loo and waic
• plot_density should link to plot_posterior, plot_dist
• plot_dist should point to plot_posterior, plot_density and plot_kde

Also as a general rule, unless there is a good reason not too (like the see also section becoming too long) all relations should be bidirectional

[sethaxen]

A few more:

• plot_khat <=> psislw
• plot_ess <=> ess
• plot_mcse <=> mcse
• plot_loo_pit <=> loo_pit
• plot_kde <=> kde
• plot_energy <=> bfmi
• rhat <=> ess, plot_ess
• mcse <=> ess
• plot_dist <=> plot_dot

less confident about these:

• plot_rank <=> plot_trace
• plot_forest <=> plot_posterior
• plot_joint <=> plot_pair

[OriolAbril]

• plot_lm: plot_ts, plot_ppc*
• plot_ts: plot_lm, plot_ppc*
• plot_parallel: plot_pair, plot_trace*
• plot_separation: plot_ppc
• plot_violin: plot_forest

the ones with the asterisk mean they don't need to be bidirectional. I imagine that plot_ppc will have a lot of see also links, so it doesn't need to also have plot_lm and plot_ts there, but it does need plot_separation.

[roshnaeem]

@OriolAbril, plot_ppc does not have a lot of links, only plot_bvp, so we can add all of them.