You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Frequency Histograms

Parameters

  • Location
    • state
    • county
    • BCR
    • my locations (eBird-only)
    • hotspot (eBird-only)
  • Period
    • What portion of year?
    • Which years?
  • Species
    1. all present at location
    2. short list
    3. single species

parameter group

description

parameter name

values

example

default

location

exactly one location parameter is required

subnational1

eBird standard subnational1 codes

US-FL

n/a

 

 

country

2-letter ISO codes

CA

n/a

 

 

bcr

integers 1-64?

14

n/a

 

 

subnational2

eBird standard subnational2 codes

 

n/a

 

 

 

 

 

 

period

  • period parameters are optional
  • if specified, both must be provided
  • constraint beginYear <= endYear

 

 

 

 

 

 

beginYear

defines beginning of period of interest, in YYYY format

2000

????

 

 

endYear

defines end of period of interest, in YYYY format

2000

????

 

 

 

 

 

 

collection

  • defines dataset of interest
  • required

collection

AKN collection codes, eBird project IDs; initially there will be no away to request the entirety of AKN data as a collection

EBIRD_PR

n/a

 

 

 

 

 

 

species

  • defines species of interest
  • optional

species

either "all" or scientific name of single species of interest; we will handle lists of species at a later date

Sialia sialis

all

 

 

 

 

 

 

output

  • defines form of output

output

"f" = returns frequency (float, 0.0-1.0)
"c" = returns category (integer, 1-5)
"i" = returns image for single species; valid only when single species is requested; implemented at a later date

f

f

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

CSV Format Output (or tab delimited)

  •  
  •  
  • if S species are returned, the response has S+1 rows
    • row #1 contains N for each of 48 "weeks"
    • rows 2 through S+1 contain species name and frequency (0 <= frequency <= 1)
  • the response contains 50 columns
  •  
  1. #* this is basically the data now returned by the "download histogram data" in eBird
    • total number of species (S)
    • S x 48 "weeks" containing
      1. frequency value (rounded to a just few digits)
      2. or, a categorical value
    • 1 x 48 "weeks" containing sample size
    • sample data
  • No labels