Skip to content

Commit

Permalink
Fix #23: add lifecycle badges to compose functions
Browse files Browse the repository at this point in the history
  • Loading branch information
teunbrand committed Oct 8, 2024
1 parent 85b6535 commit 692639e
Show file tree
Hide file tree
Showing 17 changed files with 122 additions and 2 deletions.
1 change: 1 addition & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Imports:
cli,
grid (>= 4.1.0),
gtable,
lifecycle,
rlang (>= 1.1.0),
scales (>= 1.1.1),
vctrs (>= 0.6.0)
Expand Down
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,4 @@ import(gtable)
import(rlang)
import(scales)
import(vctrs)
importFrom(lifecycle,deprecated)
3 changes: 3 additions & 0 deletions R/compose-.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

#' Guide composition
#'
#' @description
#' `r lifecycle::badge("experimental")`
#'
#' Guide composition is a meta-guide orchestrating an ensemble of other guides.
#' On their own, a 'composing' guide is not very useful as a visual reflection
#' of a scale.
Expand Down
3 changes: 3 additions & 0 deletions R/compose-crux.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

#' Compose guides in a cross
#'
#' @description
#' `r lifecycle::badge("experimental")`
#'
#' This guide composition has a central guide optionally surrounded by other
#' guides on all four sides.
#'
Expand Down
3 changes: 3 additions & 0 deletions R/compose-ontop.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

#' Compose guides on top of one another
#'
#' @description
#' `r lifecycle::badge("experimental")`
#'
#' This guide can place place other guides on top of one another.
#'
#' @inheritParams compose_stack
Expand Down
3 changes: 3 additions & 0 deletions R/compose-sandwich.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
#' Compose guides as a sandwich
#'
#' @description
#' `r lifecycle::badge("experimental")`
#'
#' This guide composition has a middle guide flanked by two parallel guides.
#'
#' @param key A [standard key][key_standard] specification. The key is shared
Expand Down
3 changes: 3 additions & 0 deletions R/compose-stack.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

#' Compose guides as stack
#'
#' @description
#' `r lifecycle::badge("experimental")`
#'
#' This guide can stack other guides.
#'
#' @param ... Guides to stack in [composition][guide-composition]. Each guide
Expand Down
5 changes: 3 additions & 2 deletions R/legendry-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
## usethis namespace: start
#' @import ggplot2
#' @import grid
#' @import rlang
#' @import vctrs
#' @import gtable
#' @import rlang
#' @import scales
#' @import vctrs
#' @importFrom lifecycle deprecated
## usethis namespace: end
NULL

Expand Down
2 changes: 2 additions & 0 deletions man/compose_crux.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/compose_ontop.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/compose_sandwich.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/compose_stack.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 21 additions & 0 deletions man/figures/lifecycle-deprecated.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions man/figures/lifecycle-experimental.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions man/figures/lifecycle-stable.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions man/figures/lifecycle-superseded.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions man/guide-composition.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 692639e

Please sign in to comment.