Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
strengejacke committed Feb 26, 2025
1 parent af8d61f commit f9ff960
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 28 deletions.
24 changes: 12 additions & 12 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,11 @@ knitr::opts_chunk$set(
)
```

[![DOI](https://joss.theoj.org/papers/10.21105/joss.01541/status.svg)](https://doi.org/10.21105/joss.01541)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.01541/status.svg)](https://doi.org/10.21105/joss.01541) [![downloads](https://cranlogs.r-pkg.org/badges/bayestestR)](https://cran.r-project.org/package=bayestestR)
[![total](https://cranlogs.r-pkg.org/badges/grand-total/bayestestR)](https://cranlogs.r-pkg.org/)

***Become a Bayesian master you will***

---

:warning: We changed the default the CI width! Please make an [informed decision](https://easystats.github.io/bayestestR/articles/credible_interval.html) and set it explicitly (`ci = 0.89`, `ci = 0.95` or anything else that you decide) :warning:

---

***Become a Bayesian master you will***

Existing R packages allow users to easily fit a large variety of models and extract and visualize the posterior draws. However, most of these packages only return a limited set of indices (e.g., point-estimates and CIs). **bayestestR** provides a comprehensive and consistent set of functions to analyze and describe posterior distributions generated by a variety of models objects, including popular modeling packages such as **rstanarm**, **brms** or **BayesFactor**.

Expand All @@ -44,7 +39,7 @@ You can reference the package and its documentation as follows:

## Installation

[![CRAN](http://www.r-pkg.org/badges/version/bayestestR)](https://cran.r-project.org/package=bayestestR) [![insight status badge](https://easystats.r-universe.dev/badges/bayestestR)](https://easystats.r-universe.dev) [![R-CMD-check](https://github.com/easystats/bayestestR/workflows/R-CMD-check/badge.svg?branch=main)](https://github.com/easystats/bayestestR/actions)
[![CRAN](https://www.r-pkg.org/badges/version/bayestestR)](https://cran.r-project.org/package=bayestestR) [![insight status badge](https://easystats.r-universe.dev/badges/bayestestR)](https://easystats.r-universe.dev) [![codecov](https://codecov.io/gh/easystats/bayestestR/branch/main/graph/badge.svg)](https://app.codecov.io/gh/easystats/bayestestR)


The *bayestestR* package is available on CRAN, while its latest development version is available on R-universe (from _rOpenSci_).
Expand All @@ -62,13 +57,18 @@ library("bayestestR")

> **Tip**
>
> **Instead of `library(bayestestR)`, use `library(easystats)`.**
> **This will make all features of the easystats-ecosystem available.**
> Instead of `library(bayestestR)`, use `library(easystats)`.
> This will make all features of the easystats-ecosystem available.
>
> **To stay updated, use `easystats::install_latest()`.**
> To stay updated, use `easystats::install_latest()`.
## Documentation

[![Documentation](https://img.shields.io/badge/documentation-bayestestR-orange.svg?colorB=E91E63)](https://easystats.github.io/bayestestR/)
[![Blog](https://img.shields.io/badge/blog-easystats-orange.svg?colorB=FF9800)](https://easystats.github.io/blog/posts/)
[![Features](https://img.shields.io/badge/features-bayestestR-orange.svg?colorB=2196F3)](https://easystats.github.io/bayestestR/reference/index.html)


Access the package [documentation](https://easystats.github.io/bayestestR/) and check-out these vignettes:

### Tutorials
Expand Down
29 changes: 13 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,11 @@
# bayestestR <img src='man/figures/logo.png' align="right" height="139" />

[![DOI](https://joss.theoj.org/papers/10.21105/joss.01541/status.svg)](https://doi.org/10.21105/joss.01541)
[![downloads](https://cranlogs.r-pkg.org/badges/bayestestR)](https://cran.r-project.org/package=bayestestR)
[![total](https://cranlogs.r-pkg.org/badges/grand-total/bayestestR)](https://cranlogs.r-pkg.org/)

***Become a Bayesian master you will***

------------------------------------------------------------------------

:warning: We changed the default the CI width! Please make an [informed
decision](https://easystats.github.io/bayestestR/articles/credible_interval.html)
and set it explicitly (`ci = 0.89`, `ci = 0.95` or anything else that
you decide) :warning:

------------------------------------------------------------------------

Existing R packages allow users to easily fit a large variety of models
and extract and visualize the posterior draws. However, most of these
packages only return a limited set of indices (e.g., point-estimates and
Expand All @@ -36,10 +29,10 @@ You can reference the package and its documentation as follows:

## Installation

[![CRAN](http://www.r-pkg.org/badges/version/bayestestR)](https://cran.r-project.org/package=bayestestR)
[![CRAN](https://www.r-pkg.org/badges/version/bayestestR)](https://cran.r-project.org/package=bayestestR)
[![insight status
badge](https://easystats.r-universe.dev/badges/bayestestR)](https://easystats.r-universe.dev)
[![R-CMD-check](https://github.com/easystats/bayestestR/workflows/R-CMD-check/badge.svg?branch=main)](https://github.com/easystats/bayestestR/actions)
[![codecov](https://codecov.io/gh/easystats/bayestestR/branch/main/graph/badge.svg)](https://app.codecov.io/gh/easystats/bayestestR)

The *bayestestR* package is available on CRAN, while its latest
development version is available on R-universe (from *rOpenSci*).
Expand All @@ -57,13 +50,17 @@ library("bayestestR")

> **Tip**
>
> **Instead of `library(bayestestR)`, use `library(easystats)`.** **This
> will make all features of the easystats-ecosystem available.**
> Instead of `library(bayestestR)`, use `library(easystats)`. This will
> make all features of the easystats-ecosystem available.
>
> **To stay updated, use `easystats::install_latest()`.**
> To stay updated, use `easystats::install_latest()`.
## Documentation

[![Documentation](https://img.shields.io/badge/documentation-bayestestR-orange.svg?colorB=E91E63)](https://easystats.github.io/bayestestR/)
[![Blog](https://img.shields.io/badge/blog-easystats-orange.svg?colorB=FF9800)](https://easystats.github.io/blog/posts/)
[![Features](https://img.shields.io/badge/features-bayestestR-orange.svg?colorB=2196F3)](https://easystats.github.io/bayestestR/reference/index.html)

Access the package
[documentation](https://easystats.github.io/bayestestR/) and check-out
these vignettes:
Expand Down Expand Up @@ -159,7 +156,7 @@ describe_posterior(
##
## Parameter | Median | 95% CI | pd | ps
## ----------------------------------------------------
## Posterior | 3.05e-03 | [-1.92, 1.95] | 50.09% | 0.46
## Posterior | 6.50e-03 | [-1.96, 1.97] | 50.20% | 0.46
```

`describe_posterior()` works for many objects, including more complex
Expand Down Expand Up @@ -462,7 +459,7 @@ Compute the density of a given point of a distribution.

``` r
density_at(rnorm(1000, 1, 1), 1)
## [1] 0.36
## [1] 0.39
```

## Code of Conduct
Expand Down
1 change: 1 addition & 0 deletions bayestestR.Rproj
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Version: 1.0
ProjectId: e3e3f8bd-9307-422e-94ac-03ac7fc7ad5c

RestoreWorkspace: No
SaveWorkspace: No
Expand Down
Binary file modified man/figures/unnamed-chunk-8-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f9ff960

Please sign in to comment.