Add examples of converting base R 3-D array and mcmc/mcmc.list objects to README.md

[avehtari]

Add examples of converting base R 3-D array and mcmc/mcmc.list objects

As it took me a moment to figure out how to convert R 3-D array to draws so that variables are named (as the approach used for matrix doesn't work) it is probably helpful for others to see the example, too.

I didn't even know that mcmc/mcmc.list object conversion is supported, and it would be useful to mention it at least once somewhere, so that it is possible to point others to tha information.

[codecov-commenter]

Codecov Report

Merging #301 (1245251) into master (e23467b) will not change coverage.
The diff coverage is n/a.

❗ Current head 1245251 differs from pull request most recent head c5c5f9f. Consider uploading reports for the commit c5c5f9f to get more accurate results

@@           Coverage Diff           @@
##           master     #301   +/-   ##
=======================================
  Coverage   95.66%   95.66%           
=======================================
  Files          46       46           
  Lines        3645     3645           
=======================================
  Hits         3487     3487           
  Misses        158      158           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[github-actions]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if 1245251 is merged into master:

•   :ballot_box_with_check:as_draws_array: 161ms -> 162ms [-1.25%, +1.86%]
•   :ballot_box_with_check:as_draws_df: 56ms -> 55.9ms [-4.02%, +3.52%]
•   :ballot_box_with_check:as_draws_list: 287ms -> 286ms [-2.32%, +1.54%]
•   :ballot_box_with_check:as_draws_matrix: 49.5ms -> 49.9ms [-3.34%, +4.75%]
•   :ballot_box_with_check:as_draws_rvars: 262ms -> 265ms [-1.58%, +3.57%]
•   :ballot_box_with_check:summarise_draws_100_variables: 1.11s -> 1.12s [-1.93%, +3.33%]
•   :ballot_box_with_check:summarise_draws_10_variables: 124ms -> 125ms [-1.77%, +3.37%]
  Further explanation regarding interpretation and methodology can be found in the documentation.

[paul-buerkner]

We do not require coda and rjags in posterior so I assume we will fail some checks by adding these packages to the readme. Did you run the usual CMD checks with this already? if not, I will do it when working on the new posterior release in the next few days.

[paul-buerkner]

I think you edited the readme.md file directly, but all changes should only go to the readme.Rmd file which will then be used to render the corresponding .md file. Anyway, I have made the necessary changes and will merge now. Thank you for this addition!

[github-actions]

This is how benchmark results would change (along with a 95% confidence interval in relative change) if 9aa5a8d is merged into master:

•   :ballot_box_with_check:as_draws_array: 159ms -> 159ms [-0.78%, +1.53%]
•   :ballot_box_with_check:as_draws_df: 55.9ms -> 55.5ms [-2.15%, +0.95%]
•   :ballot_box_with_check:as_draws_list: 282ms -> 280ms [-2.84%, +1.54%]
•   :ballot_box_with_check:as_draws_matrix: 48ms -> 48.1ms [-1.61%, +1.85%]
•   :ballot_box_with_check:as_draws_rvars: 261ms -> 259ms [-2.93%, +2%]
•   :ballot_box_with_check:summarise_draws_100_variables: 1.1s -> 1.1s [-1.23%, +1.02%]
•   :ballot_box_with_check:summarise_draws_10_variables: 122ms -> 120ms [-3.96%, +0.59%]
  Further explanation regarding interpretation and methodology can be found in the documentation.