R/tracks_ts.R

In parksandwildlife/wastdr: WA Sea Turtle Database 'WAStD' API Wrapper

#' Plot of nesting_type_by_season_day_species over time
#'
#' @param data The output of \code{parse_turtle_nest_encounters}.
#' @template param-surveys
#' @template param-local_dir
#' @template param-placename
#' @template param-prefix
#' @template param-export
#' @return A ggplot2 object. Saves the plot to .png.
#' @export
#' @family wastd
tracks_ts <- function(data,
                      surveys,
                      local_dir = here::here(),
                      placename = "",
                      prefix = "",
                      export = FALSE) {
  fname <-
    glue::glue("{prefix}_track_abundance_{wastdr::urlize(placename)}.png")
  plt <- data %>%
    wastdr::nesting_type_by_season_day_species(.) %>%
    {
      ggplot2::ggplot() +
        ggplot2::facet_grid(rows = ggplot2::vars(season), scales = "free_x") +
        ggplot2::scale_x_continuous(
          labels = function(x) {
            fdate_as_tdate(x)
          }
        ) +
        ggplot2::scale_y_continuous(limits = c(0, NA)) +
        ggplot2::geom_bar(
          data = wastdr::filter_realsurveys(surveys),
          ggplot2::aes(x = tdate_as_fdate(turtle_date)),
          show.legend = FALSE
        ) +
        ggalt::geom_lollipop(
          data = .,
          ggplot2::aes(
            x = tdate_as_fdate(turtle_date),
            y = n,
            colour = nest_type
          ),
          point.size = 2
        ) +
        ggplot2::ggtitle(
          glue::glue("Nesting activity at {placename}"),
          subtitle = glue::glue(
            "Number counted per day (points) over number of surveys (bars)"
          )
        ) +
        ggplot2::ylab("Number of turtle tracks or nests") +
        ggplot2::xlab("Turtle date") +
        ggplot2::guides(colour = ggplot2::guide_legend(title = "Nest type")) +
        ggplot2::theme_classic()
    }

  if (export == TRUE) {
    ggplot2::ggsave(
      plot = plt,
      filename = fname,
      path = local_dir,
      width = 10,
      height = 6
    )
  }
  plt
}

# usethis::use_test("tracks_ts")