Update docs, redocument

Author: matt-dray

NAMESPACE

@@ -1,5 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
+export(convert_md_to_html)
+export(fetch_strategy_description)
 export(plot_rates)
 export(run_app)
 importFrom(rlang,.data)

R/utils_description.R

@@ -1,22 +1,22 @@
 #' Fetch Strategy Text from NHP Inputs
 #' @param strategy Character. The variable name for a strategy, e.g.
 #'     `"discharged_no_treatment_adult_ambulance"`.
+#' @param descriptions_lookup Character. The names of the available Markdown
+#'     description files.
 #' @details Markdown files containing strategy descriptions are read from
 #'     [NHP Inputs](https://github.com/The-Strategy-Unit/nhp_inputs/).
 #' @return Character.
 #' @export
 fetch_strategy_description <- function(strategy, descriptions_lookup) {
-  strategy_text <- descriptions_lookup[stringr::str_detect(
-    strategy,
-    descriptions_lookup
-  )]
+  is_stub <- stringr::str_detect(strategy, descriptions_lookup)
+  strategy_stub <- descriptions_lookup[is_stub]
 
   withr::with_tempfile("temp", {
     # nolint start object_usage_linter.
     utils::download.file(
       glue::glue(
         "https://raw.githubusercontent.com/The-Strategy-Unit/nhp_inputs/",
-        "refs/heads/main/inst/app/strategy_text/{strategy_text}.md"
+        "refs/heads/main/inst/app/strategy_text/{strategy_stub}.md"
       ),
       temp
     )