ecoengine (version 1.12.0)

ee_photos: ee_photos

Description

Search the photos methods in the ecoengine API.

Usage

ee_photos(
  page = NULL,
  state_province = NULL,
  county = NULL,
  genus = NULL,
  scientific_name = NULL,
  authors = NULL,
  remote_id = NULL,
  collection_code = NULL,
  source = NULL,
  min_date = NULL,
  max_date = NULL,
  related_type = NULL,
  related = NULL,
  page_size = 1000,
  quiet = FALSE,
  georeferenced = FALSE,
  progress = FALSE,
  other_catalog_numbers = NULL,
  foptions = list()
)

Arguments

page

Page number

state_province

Need to describe these parameters

county

California counties. Package include a full list of counties. To load dataset data(california_counties)

genus

genus name

scientific_name

scientific name

authors

author name

remote_id

remote id

collection_code

Type of collection. Can be CalAcademy, Private, VTM, CDFA. CalFlora Others TBA

source

data source. See ee_sources

min_date

Lower date bound. Most be in format Y-m-D h:m:s. This package uses lubridate's ymd_hms function to format dates.

max_date

upper date bound. Most be in format Y-m-D h:m:s. This package uses lubridate's ymd_hms function to format dates.

related_type

Need to describe these parameters

related

Need to describe these parameters

page_size

The number of observations per page returned by the query. The package default is 250 observations. The API default, however, is 10. Setting this number higher will require fewer calls (i.e. pages) but a large size may also fail or timeout.

quiet

Default is FALSE. Set to TRUE to suppress messages.

georeferenced

Default is FALSE. Set to TRUE to filter by photos that have geo data.

progress

Progress bar is set to TRUE by default. Use FALSE especially when calling functions inside documents.

other_catalog_numbers

Need to describe these parameters

foptions

A list of additional arguments for httr. There is no reason to use this argument except for debugging purposes.

See Also

related: ee_photos california_counties

Examples

# NOT RUN {
# Request all photos. This request will paginate.
# merced <- ee_photos(county = "Merced County")
 ee_photos(page_size = 10)
# Search by collection code. See notes above on options
# ee_photos(collection_code = "CalAcademy")
# ee_photos(collection_code = "VTM")
# ee_photos(collection_code = "CalFlora")
# ee_photos(collection_code = "CDFA")
# Search by county.
# sc_county <- ee_photos(county = "Santa Clara County")
# merced <- ee_photos(county = "Merced County")
# merced <- ee_photos(county = "Merced County", page = "all")
# The package also contains a full list of counties
data(california_counties)
# alameda <- ee_photos(county = california_counties[1, 1])
# alameda$data
# You can also get all the data for Alameda county with one request
# alameda <- ee_photos(county = "Alameda county", page = "all")
# Spidering through the rest of the counties can easily be automated.
# Or by author
# charles_results <- ee_photos(author = "Charles Webber", page = 1:2)
# You can also request all pages in a single call by using ee_photos()
# In this example below, there are 6 pages of results (52 result items).
# Function will return all at once.
# racoons <- ee_photos(scientific_name = "Procyon lotor", page = "all")
# }