parse_surveys: Parse a 'wastd_api_response' of 'surveys' to tbl_df

View source: R/parse_surveys.R

parse_surveysR Documentation

Parse a wastd_api_response of surveys to tbl_df

Description

\lifecycle

maturing

Usage

parse_surveys(
  wastd_api_response,
  wastd_url = wastdr::get_wastd_url(),
  payload = "data"
)

Arguments

wastd_api_response

A wastd_api_response of surveys, e.g. get_wastd("surveys")

wastd_url

The base URL for WAStD, default: get_wastd_url()

payload

The parameter payload for wastd_parse.

Value

A tbl_df with columns:

  • area_name (chr) The name of the Locality this Survey took place in.

  • area_id (int) The ID of the Locality this Survey took place in.

  • site_name (chr) The name of the Site this Survey took place in.

  • site_id (int) The ID of the Site this Survey took place in.

  • reporter (chr)

  • reporter_username (chr)

  • reporter_id (chr)

  • start_time (dttm) The actual start time of the survey.

  • end_time (dttm) The actual, automatically guessed (if 6h later), or human guessed end time.

  • start_comments (chr) Comments at start plus QA messages from username guessing

  • end_comments (chr) Comments at end plus QA messages from username guessing. A mismatch of original usernames can indicate an incorrectly picked Site Visit End point.

  • turtle_date (dttm) The "turtle date" of the survey.

  • season_week (int) The number of completed weeks since fiscal year start

  • iso_week (int) The number of completed weeks since calendar year start

  • season (int) The "turtle season" of the survey, rolling over with Fiscal Year.

  • source (chr) Where this record was born.

  • source_id (chr) The ODK record UID of the Site Visit Start.

  • end_source_id (chr) The ODK record UID of the Site Visit End.

  • status (chr) The QA status of the Survey. "Proofread" or "Curated" indicate human QA edits.

  • device_id (chr) The unique ID of the device the Site Visit Start was captured on.

  • end_device_id (chr) The unique ID of the device the Site Visit End was captured on.

  • status (chr) QA status of the survey.

  • id (int) WAStD ID of the survey.

  • is_production (bool) Whether this survey is a real (production) or a training survey.

  • absolute_admin_url (chr) The absolute URL path to edit the survey in WAStD. Append this to the base WASTD_URL.

See Also

Other wastd: add_nest_labels(), disturbance_by_season(), filter_alive(), filter_dead(), filter_disturbance(), filter_predation(), ggplot_disturbance_by_season(), ggplot_emergence_success(), ggplot_hatching_success(), ggplot_hatchling_misorientation(), ggplot_nesting_success_per_area_season_species_pct(), ggplot_nesting_success_per_area_season_species(), ggplot_sighting_status_per_area_season_species(), ggplot_total_emergences_per_area_season_species(), ggplot_track_success_by_date(), ggplot_track_successrate_by_date(), hatching_emergence_success_area(), hatching_emergence_success_site(), hatching_emergence_success(), map_dist(), map_fanangles(), map_mwi(), map_nests(), map_tracks(), map_wastd_wamtram_sites(), map_wastd(), nesting_success_per_area_day_species(), nesting_success_per_area_season_species(), nesting_type_by_area_season_age_species(), nesting_type_by_area_season_species(), nesting_type_by_season_age_species(), nesting_type_by_season_calendarday_age_species(), nesting_type_by_season_calendarday_species(), nesting_type_by_season_day_species(), nesting_type_by_season_species(), nesting_type_by_season_week_age_species(), nesting_type_by_season_week_site_species(), nesting_type_by_season_week_species(), nesting_type_by_site_season_age_species(), nesting_type_by_site_season_species(), parse_animal_encounters(), parse_area_sf(), parse_area(), parse_encounterobservations(), parse_turtle_nest_encounters(), print.wastd_api_response(), sighting_status_per_area_season_species(), sighting_status_per_site_season_species(), summarise_hatching_and_emergence_success(), summarise_wastd_data_per_day_site(), total_emergences_per_area_season_species(), total_emergences_per_site_season_species(), track_success_by_species(), track_success(), tracks_ts()


parksandwildlife/wastdr documentation built on Nov. 17, 2022, 4:52 p.m.