R/text.R

In pbs-assess/herringutils: Provides Plotting, Table-making, and Utility Functions for the CSAS Herring Documents

#' Text for "Stock status update" section.
#'
#' @param SAR Character. SAR name (e.g., "HG").
#' @param this_yr Numeric. Usually `assess_yr`.
#' @param p_lrp Numeric. Proportion of SB_0 that is the LRP (default is 0.3).
#' @param translate Logical. Translate to french if TRUE.
#'
#' @note Requires variables from the `get_vars()` function named for the SAR
#'   (i.e., `hg_vars <- get_vars("HG", french = french)`).
#'
#' @export
#' @return Text.
stock_status_text <- function(SAR,
                              this_yr,
                              p_lrp = 0.3,
                              translate) {
  vars <- get(paste0(tolower(SAR), "_vars"))
  res <- paste0(
    ifelse(
      translate,
      "La biomasse reproductrice non pêchée estimée ",
      "Estimated unfished spawning biomass "
    ),
    "$\\SB_0$ ",
    ifelse(translate, "est de ", "is "),
    f(vars$sbo[2]), "$\\,\\text{t}$, ",
    ifelse(translate, "et le PRL de ", "and the LRP of "),
    "$", p_lrp, "\\SB_0$ ",
    ifelse(translate, "est de ", "is "),
    f(p_lrp * vars$sbo[2]), "$\\,\\text{t}$ ",
    ifelse(translate, "(médianes postérieures). ", "(posterior medians). "),
    ifelse(
      translate,
      "Par rapport à l'année dernière, la biomasse reproductrice estimée en ",
      "Compared to last year, estimated spawning biomass "
    ),
    if (translate) {
      ifelse(
        vars$final_yr_sbt[2] > vars$prev_yr_sbt[2],
        "a diminué de ",
        "a augmenté de "
      )
    },
    if (!translate) {
      ifelse(
        vars$final_yr_sbt[2] > vars$prev_yr_sbt[2],
        "increased from ",
        "decreased from "
      )
    },
    f(vars$prev_yr_sbt[2]), " ($\\SB_{", this_yr - 1, "}$)",
    ifelse(translate, " à ", " to "),
    f(vars$final_yr_sbt[2]), "$\\,\\text{t}$ ",
    "($\\SB_{", this_yr, "}$, ",
    ifelse(
      translate,
      "médiane postérieure), ce qui correspond à ",
      "posterior median), and is equivalent to "
    ),
    f(vars$final_yr_dt[2] * 100, 1), "% ",
    ifelse(translate, "de ", "of "),
    "$\\SB_0$ (",
    ifelse(translate, "tableaux ", "Tables "),
    "\\@ref(tab:", tolower(SAR), "-spawning-biomass-depletion) & ",
    "\\@ref(tab:ref-points-", tolower(SAR), ")). ",
    ifelse(
      translate,
      "On estime que la biomasse de frai en ",
      "Spawning biomass in "
    ),
    this_yr,
    ifelse(
      translate,
      " sera supérieure au PLR avec une probabilité de ",
      " is estimated to be above the LRP with a "
    ),
    f((1 - vars$prob_less_03sbo) * 100, 1), "% ",
    ifelse(
      translate,
      "(tableau ",
      "probability (Table "
    ),
    "\\@ref(tab:ref-points-", tolower(SAR), "))."
  )
  # Encoding(res) <- "UTF-8"
  res
}

#' Text for "Application of MPs.." section.
#'
#' @param SAR Character. SAR name (e.g., "HG").
#' @param next_yr Numeric. Usually `assess_yr + 1`.
#' @param p_lrp Numeric. Proportion of SB_0 that is the LRP (default is 0.3).
#' @param translate Logical. Translate to french if TRUE.
#'
#' @note Requires variables from the `get_vars()` function named for the SAR
#'   (i.e., `hg_vars <- get_vars("HG", french = french)`).
#'
#' @export
#' @return Text.
proj_biomass_text <- function(SAR,
                              next_yr,
                              p_lrp = 0.3,
                              translate) {
  vars <- get(paste0(tolower(SAR), "_vars"))
  res <- paste0(
    ifelse(
      translate,
      "En l'absence de pêche, la biomasse féconde en ",
      "In the absence of fishing, spawning biomass in "
    ),
    next_yr, " $\\SB_{", next_yr, "}$ ",
    ifelse(translate, "est prévu pour être ", "is forecast to be "),
    f(vars$proj_sbt[2]), "$\\,\\text{t}$ ",
    ifelse(
      translate,
      "(médiane postérieure; tableau ",
      "(posterior median; Table "
    ),
    "\\@ref(tab:ref-points-", tolower(SAR), ")). ",
    ifelse(
      translate,
      "On prévoit que la biomasse de frai en ",
      "Spawning biomass in "
    ),
    next_yr,
    ifelse(
      translate,
      " sera inférieure au PRL de ",
      " is forecast to be below the LRP of "
    ),
    "$", p_lrp, "\\SB_0$ (", f(p_lrp * vars$sbo[2]), "$\\,\\text{t}$) ",
    ifelse(translate, "avec une probabilité de ", "with a "),
    f(vars$prob_proj_less_03sbo * 100, 1), "% ",
    ifelse(
      translate,
      "en l'absence de pêche (tableau ",
      "probability, in the absence of fishing (Table "
    ),
    "\\@ref(tab:ref-points-", tolower(SAR),
    ifelse(translate, ") et figure ", ") and Figure "),
    "\\@ref(fig:proj-biomass-density))."
  )
  # Encoding(res) <- "UTF-8"
  res
}

#' Text for "Application of MPs.." section.
#'
#' @param SAR Character. SAR name (e.g., "HG").
#' @param translate Logical. Translate to french if TRUE.
#'
#' @note Requires variables from the `get_vars()` function named for the SAR
#'   (i.e., `hg_vars <- get_vars("HG", french = french)`).
#'
#' @export
#' @return Text.
mean_harvest_text <- function(SAR,
                              translate){
  vars <- get(paste0(tolower(SAR), "_vars"))
  res <- paste0(
    ifelse(
      translate,
      "Le taux de récolte effectif $U_t$ moyen pour les ",
      "The mean effective harvest rate $U_t$ for the past "
    ),
    vars$n_hr_yrs,
    ifelse(
      translate,
      " dernières années avec des captures non nulles (de ",
      " years with non-zero catches (from "
    ),
    min(vars$hr_yrs),
    ifelse(
      translate,
      " à ",
      " to "
    ),
    max(vars$hr_yrs),
    ifelse(
      translate,
      ") est de ",
      ") is "
    ),
    f(vars$hr_mean * 100),
    "%",
    ifelse(
      translate,
      " (figure",
      " (Figure "),
    "\\@ref(fig:harvest-rate))."
  )
  res
}