R/filters.R

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

#' Exclude records with \code{species} "corolla-corolla".
#'
#' \lifecycle{stable}
#'
#' @param x A tibble with a column "species".
#' @export
#' @family helpers
exclude_training_species <- function(x) {
  x %>%
    {
      if ("species" %in% names(.)) {
        dplyr::filter(., species != "corolla-corolla")
      } else {
        .
      }
    } %>%
    {
      if ("encounter_species" %in% names(.)) {
        dplyr::filter(., encounter_species != "corolla-corolla")
      } else {
        .
      }
    }
}

#' @export
#' @rdname exclude_training_species
filter_realspecies <- function(x) {
  x %>%
    {
      if ("species" %in% names(.)) {
        dplyr::filter(., species != "corolla-corolla")
      } else {
        .
      }
    } %>%
    {
      if ("encounter_species" %in% names(.)) {
        dplyr::filter(., encounter_species != "corolla-corolla")
      } else {
        .
      }
    }
}

#' Exclude ODKC records with \code{species} "corolla-corolla".
#'
#' \lifecycle{stable}
#'
#' @param x A tibble with a column "details_species".
#' @export
#' @family odkc
exclude_training_species_odkc <- function(x) {
  x %>%
    dplyr::filter(details_species != "corolla-corolla")
}

#' Filter records with missing \code{survey_id}
#'
#' \lifecycle{stable}
#'
#' @param x The output of \code{\link{parse_surveys}}
#' @export
#' @family helpers
filter_missing_survey <- function(x) {
  x %>% dplyr::filter(is.na(survey_id))
}

#' @export
#' @rdname filter_missing_survey
filter_nosurvey <- function(x) {
  x %>% dplyr::filter(is.na(survey_pk))
}

#' Filter records with missing \code{site_id}
#' @param x The output of \code{parse_turtle_nest_encounters}
#' @export
#' @family helpers
filter_missing_site <- function(x) {
  x %>% dplyr::filter(is.na(site_pk))
}

#' @export
#' @rdname filter_missing_site
filter_nosite <- function(x) {
  x %>% dplyr::filter(is.na(site_pk))
}

#' Exclude training surveys.
#'
#' \lifecycle{stable}
#'
#' @param x The output of \code{parse_surveys}
#' @export
#' @family helpers
exclude_training_surveys <- function(x) {
  x %>% dplyr::filter(is_production == TRUE)
}

#' @export
#' @rdname exclude_training_surveys
filter_realsurveys <- function(x) {
  x %>% dplyr::filter(is_production == TRUE)
}
#' Filter surveys with "NEEDS QA" in \code{start_comments} or
#' \code{end_comments}.
#'
#' \lifecycle{stable}
#'
#' @param x The output of \code{parse_surveys}
#' @export
#' @family helpers
filter_surveys_requiring_qa <- function(x) {
  x %>%
    dplyr::filter(
      grepl("NEEDS QA", start_comments) | grepl("NEEDS QA", end_comments)
    ) %>%
    dplyr::select(
      change_url, turtle_date, site_name, reporter, reporter_username,
      start_comments, end_comments
    )
}

#' Filter surveys with a missing \code{end_source_id}.
#'
#' \lifecycle{stable}
#'
#' @param x The output of \code{parse_surveys}
#' @export
#' @family helpers
filter_surveys_missing_end <- function(x) {
  x %>%
    dplyr::filter(is.na(end_source_id)) %>%
    dplyr::select(
      change_url, turtle_date, site_name, reporter, season,
      start_time, end_time, start_comments, end_comments
    )
}

#' Filter a dataframe of tracks, disturbance, incidents, or surveys to season
#'
#' \lifecycle{stable}
#'
#' @param data A dataframe of tracks, disturbance, incidents, or surveys
#'  containing a column "season" (int) with the season start year, e.g. 2019.
#' @param season_start_year The desired season's start year, e.g. 2019.
#' @return The dataframe filtered to rows from the desired season.
#' @export
#' @family helpers
filter_wastd_season <- function(data, season_start_year) {
  dplyr::filter(data, season == season_start_year)
}

# usethis::use_test("filters")