run information console output

NAMESPACE

@@ -42,6 +42,7 @@ export(msf_mortalities_chinook_)
 export(msf_mortalities_coho_)
 export(population_statistics)
 export(remove_run)
+export(run_info)
 export(statistical_week)
 export(stock_mortality)
 importFrom(rlang,.data)

R/integrity.R

@@ -178,3 +178,30 @@ remove_run <- function(fram_db, run_id){
     ))
 
 }
+
+#' Provides a print out of Run ID information
+#' @param fram_db FRAM database object
+#' @param run_id FRAM run ID
+#' @export
+#' @examples
+#' \dontrun{fram_db |> run_info(run_id = 132)}
+#'
+
+run_info <- function(fram_db, run_id = NULL) {
+  if (is.null(run_id)) {rlang::abort('A run ID must be provided')}
+
+  run_info <- fram_db |>
+    fetch_table('RunID') |>
+    dplyr::filter(.data$run_id == .env$run_id)
+
+  cli::cli_h1('FRAM Run Information')
+  cli::cli_text(cat(cli::col_blue('Species: '), cli::col_grey(run_info$species_name[[1]])))
+  cli::cli_text(cat(cli::col_blue('Run Name: '), cli::col_grey(run_info$run_name[[1]])))
+  cli::cli_text(cat(cli::col_blue('Run Title: '), cli::col_grey(run_info$run_title[[1]])))
+  cli::cli_text(cat(cli::col_blue('Run Date: '), cli::col_grey(run_info$run_time_date[[1]])))
+  cli::cli_text(cat(cli::col_blue('TAMM: '), cli::col_grey(run_info$tamm_name[[1]])))
+  cli::cli_text(cat(cli::col_blue('Coast Iterations: '), cli::col_grey(run_info$coastal_iterations[[1]])))
+  cli::cli_text(cat(cli::col_blue('Run Comments: '), '\n', cli::col_grey(run_info$run_comments[[1]])))
+
+}
+