Skip to content

Commit

Permalink
Merge branch 'master' into facet-depracated
Browse files Browse the repository at this point in the history
  • Loading branch information
jgabry authored Jan 17, 2024
2 parents 260804e + b1ef699 commit 0f4df8c
Show file tree
Hide file tree
Showing 6 changed files with 71 additions and 4 deletions.
56 changes: 56 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Contributing to bayesplot

This outlines how to propose a change to bayesplot and is based on similar
instructions for tidyverse packages, including the contributing guidelines
generated by `usethis::use_tidy_contributing()`.

## Fixing typos

You can fix typos, spelling mistakes, or grammatical errors in the documentation
directly using the GitHub web interface, as long as the changes are made in the
_source_ file. This generally means you'll need to edit
[roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R`,
not a `.Rd` file. You can find the `.R` file that generates the `.Rd` by reading
the comment in the first line.

## Bigger changes

If you want to make a bigger change, it's a good idea to first file an issue and
make sure someone from the team agrees that it’s needed. If you’ve found a bug,
please file an issue that illustrates the bug with a minimal reproducible
example (see e.g. the [tidyverse reprex instructions](https://www.tidyverse.org/help/#reprex)).
The tidyverse guide on [how to create a great issue](https://code-review.tidyverse.org/issues/)
has more advice.

### Pull request process

If you are new to creating pull requests here are some tips. Using the functions
from the `usethis` package is not required but can be helpful if this process is
new to you.

* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("stan-dev/bayesplot", fork = TRUE)`.

* Install all development dependencies with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`.
If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing.
* Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`.

* Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser.
The title of your PR should briefly describe the change.
The body of your PR should contain `Fixes #issue-number`.

* For user-facing changes, add a bullet to the top of `NEWS.md` (i.e. just below the first header). Follow the style already used in `NEWS.md`.

### Code style

* New code should attempt to follow the style used in the package. When in doubt follow the tidyverse [style guide](https://style.tidyverse.org).

* We use [roxygen2](https://cran.r-project.org/package=roxygen2), with [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html), for documentation.

* We use [testthat](https://cran.r-project.org/package=testthat) for unit tests.
Contributions with test cases included are easier to accept.

## Code of Conduct

Please note that the bayesplot project follows the Stan project's
[Code of Conduct](https://discourse.mc-stan.org/t/announcing-our-new-stan-code-of-conduct/23764).
By contributing to this project you agree to abide by its terms.
3 changes: 1 addition & 2 deletions R/bayesplot-ggplot-themes.R
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,7 @@ theme_default <-
panel.spacing = unit(1.5, "lines"),
legend.position = "right",
legend.background = element_blank(),
legend.text = element_text(size = 13),
legend.text.align = 0,
legend.text = element_text(size = 13, hjust = 0),
legend.key = element_blank()
)
}
Expand Down
6 changes: 5 additions & 1 deletion R/bayesplot-helpers.R
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,11 @@ calc_intervals <- function(x, p, med = TRUE, ...) {
#' equivalent to using `legend_none()`.
#'
legend_move <- function(position = "right") {
theme(legend.position = position)
if (is.numeric(position) && "legend.position.inside" %in% fn_fmls_names(theme)) {
theme(legend.position = "inside", legend.position.inside = position)
} else {
theme(legend.position = position)
}
}
#' @rdname bayesplot-helpers
#' @export
Expand Down
1 change: 1 addition & 0 deletions R/mcmc-traces.R
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,7 @@ mcmc_rank_hist <- function(x,
# Otherwise, use a grid.
if (n_param > 1) {
facet_f <- facet_grid
names(facet_args)[names(facet_args) == "facets"] <- "rows"
} else {
facet_f <- facet_wrap
facet_args[["nrow"]] <- facet_args[["nrow"]] %||% 1
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ _J. R. Stat. Soc. A_, 182: 389-402. doi:10.1111/rssa.12378.
* [Ask a question](https://discourse.mc-stan.org) (Stan Forums on Discourse)
* [Open an issue](https://github.com/stan-dev/bayesplot/issues) (GitHub issues for bug reports, feature requests)

### Contributing

We are always looking for new contributors! See [CONTRIBUTING.md](https://github.com/stan-dev/bayesplot/blob/master/.github/CONTRIBUTING.md) for details and/or reach out via the issue tracker.

### Installation

* Install from CRAN:
Expand Down
5 changes: 4 additions & 1 deletion tests/testthat/test-convenience-functions.R
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,10 @@ test_that("legend_move returns correct theme object", {

pos <- legend_move(c(0.25, 0.5))
expect_s3_class(pos, "theme")
expect_equivalent(pos, list(legend.position = c(0.25, 0.5)))
expect_equivalent(
pos$legend.position.inside %||% pos$legend.position,
c(0.25, 0.5)
)
expect_false(attr(pos, "complete"))
})
test_that("legend_text returns correct theme object", {
Expand Down

0 comments on commit 0f4df8c

Please sign in to comment.