Skip to content

Commit

Permalink
add missing lifecycle badge images
Browse files Browse the repository at this point in the history
  • Loading branch information
nkehrein committed Oct 23, 2024
1 parent 6c4a379 commit b7df46b
Show file tree
Hide file tree
Showing 12 changed files with 110 additions and 5 deletions.
5 changes: 5 additions & 0 deletions R/plotting.r
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#' Creates plot of model results (uncertainties optional)
#'
#' `r lifecycle::badge("experimental")`
#' All parameter combinations and exposure patterns are simulated and the mean
#' of predictions is derived for a single study. The uncertainty is
#' passed to the function due to computation time. Results are displayed by
Expand Down Expand Up @@ -250,6 +251,7 @@ plot_sd <- function(model_base,

#' Creates a PPC plot for a single dataset
#'
#' `r lifecycle::badge("experimental")`
#' A sample of parameters representing the uncertainty within the dataset
#' is passed to the function. All parameter combinations and exposure patterns
#' are simulated and the range of predicted frond numbers is derived for a
Expand Down Expand Up @@ -355,6 +357,7 @@ plot_ppc <- function(rs_mean,

#' Create PPC plot for one or more datasets
#'
#' `r lifecycle::badge("experimental")`
#' The function expects a data.frame with five mandatory and one optional
#' column. The mandatory columns are as follows:
#' - `pred`: mean of predictions e.g. frond number for lemna
Expand Down Expand Up @@ -459,6 +462,7 @@ plot_ppc_combi <- function(table, xy_lim = NULL) {

#' Plot EPx values
#'
#' `r lifecycle::badge("experimental")`
#' @param EPx_ts the result of `epx_mtw`, ie. a tibble with window.start,
#' window.end, endpoint, level and EPx
#' @param exposure_ts an exposure time series with columns for time 't' and
Expand Down Expand Up @@ -550,6 +554,7 @@ plot_epx <- function(EPx_ts, exposure_ts, draw = TRUE, time_col = "time", conc_c

#' Creates a prediction plot for one effect scenario
#'
#' `r lifecycle::badge("experimental")`
#' Sometimes it is helpful if the user can plot results of one effect
#' scenario. This is for instance the case for test simulations or predictions
#' for one profile. This function runs the simulation for one effect scenario
Expand Down
6 changes: 4 additions & 2 deletions R/survival.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
#' Survival rate
#'
#' *Deprecated function*. Derives the survival rate of individuals for
#' *Reduced GUTS* models. Was replaced by [simulate()].
#' `r lifecycle::badge("deprecated")`
#' Derives the survival rate of individuals for
#' *Reduced GUTS* models. Function was replaced by output of [simulate()] and
#' will be removed in a later version.
#'
#' The survival rate describes the survival probability at each
#' time point. The function simulates the *GUTS* scenario and appends a column
Expand Down
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: 1 addition & 1 deletion man/plot_epx.Rd

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

1 change: 1 addition & 0 deletions man/plot_ppc.Rd

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

1 change: 1 addition & 0 deletions man/plot_ppc_combi.Rd

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

1 change: 1 addition & 0 deletions man/plot_scenario.Rd

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

1 change: 1 addition & 0 deletions man/plot_sd.Rd

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

6 changes: 4 additions & 2 deletions man/survival.Rd

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

0 comments on commit b7df46b

Please sign in to comment.