Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

plot_ribbon_em() has docs but no @export #132

Open
PietrH opened this issue Jul 2, 2024 · 0 comments
Open

plot_ribbon_em() has docs but no @export #132

PietrH opened this issue Jul 2, 2024 · 0 comments

Comments

@PietrH
Copy link
Member

PietrH commented Jul 2, 2024

During b-cubed review, from b9e68fd I noticed plot_ribbon_em() has rendered docs, and is available, but does not have an @export roxygen2 tag.

This came up with checkhelper::find_missing_tags()

#' Plot time series with confidence limits and emerging status
#'
#' @param df_plot df. A data.frame containing data to plot.
#' @param x_axis character. Name of column containing x-values. Default:
#'   \code{"year"}.
#' @param y_axis character. Name of column containing y-values. Default:
#'   \code{"number of observations"}.
#' @param x_label character. x-axis label. Default: \code{"x"}.
#' @param y_label character. y-axis label. Default: \code{"y"}.
#' @param ptitle character. Plot title. Default: \code{NULL}.
#' @param verbose logical. If \code{TRUE}, informations about possible issues
#'   are returned. Default: \code{FALSE}.
#' @return a ggplot2 plot object.
#' @importFrom dplyr .data %>%
plot_ribbon_em <- function(df_plot,
                           x_axis = "year",
                           y_axis = "obs",
                           x_label = "x",
                           y_label = "y",
                           ptitle = NULL,
                           verbose = FALSE) {
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant