R/get_cyclone.R

In bagyo: Philippine Tropical Cyclones Data

#'
#' Get a cyclone name
#'
#' Randomly returns a cyclone name and prints additional information available
#' from the package regarding the cyclone.
#'
#' @returns A list of information regarding a randomly selected cyclone from
#'   the `bagyo` dataset.
#'
#' @examples
#' get_bagyo()
#'
#' @rdname get_bagyo
#' @export
#'

get_bagyo <- function() {
  df <- bagyo::bagyo

  df <- df[sample(seq_len(nrow(df)), size = 1), ] |>
    as.list()

  attr(df, "class") <- "bagyo"

  df
}


#'
#' [print()] helper function for [get_bagyo()] function
#'
#' @param x Object of class `bagyo` produced by [get_bagyo()] function
#' @param ... Additional [print()] arguments
#'
#' @returns Printed output of [get_bagyo()] function
#'
#' @examples
#' get_bagyo()
#'
#' @export
#'

print.bagyo <- function(x, ...) {
  cat("\n\t*** Featured Bagyo ***\n\n", sep = "")
  cat(
    "Name:", format(x$name, width = 20, justify = "left"),
    "RSMC Name:", format(x$rsmc_name, width = 0, justify = "left"),
    "\n"
  )
  cat(
    "Year:", format(as.character(x$year), width = 20, justify = "left"),
    "Category:", format(
      paste0(x$category_name, " (", x$category_code, ")"),
      width = 0, justify = "left"),
    "\n"
  )
  cat(
    "Start:", format(x$start, format = "%Y-%m-%d %H:%M:%S", justify = "left"),
    "End:", format(x$end, format = "%Y-%m-%d %H:%M:%S", justify = "left"),
    "\n"
  )
  cat(
    "Pressure:",
    format(as.character(x$pressure), justify = "left", width = 1),
    "hPa",
    "        ",
    "Speed:", format(as.character(x$speed), justify = "left", width = 1),
    "km/h",
    "\n"
  )
}