brapi_get_seasons: get /seasons

In mverouden/brapir-v2: Client to Access BrAPI Compliant Plant Breeding Databases

get /seasons

Description

Get the Seasons

Usage

brapi_get_seasons(
  con = NULL,
  seasonDbId = "",
  season = "",
  year = as.integer(NA),
  page = 0,
  pageSize = 1000
)

Arguments

con	list; required: TRUE; BrAPI connection object
seasonDbId	character; required: FALSE; The unique identifier for a season. For backward compatibility it can be a string like '2012', '1957-2004'
season	character; required: FALSE; The term to describe a given season. Example "Spring" OR "May" OR " Planting_Time_7".
year	integer; required: FALSE; The 4 digit year of a season. Example "2017"
page	integer; required: FALSE; Used to request a specific page of data to be returned. The page indexing starts at 0 (the first page is 'page'= 0). Default is 0.
pageSize	integer; required: FALSE; The size of the pages to be returned. Default is 1000.

Details

Call to retrieve all seasons in the database.

A season is made of 2 parts; the primary year and a term which defines a segment of the year. This could be a traditional season, like "Spring" or "Summer " or this could be a month, like "May" or "June" or this could be an arbitrary season name which is meaningful to the breeding program like "PlantingTime_3" or "Season E"

Value

data.frame

Author(s)

Maikel Verouden

References

BrAPI SwaggerHub

See Also

Other brapi-core: brapi_get_commoncropnames(), brapi_get_lists_listDbId(), brapi_get_lists(), brapi_get_locations_locationDbId(), brapi_get_locations(), brapi_get_people_personDbId(), brapi_get_people(), brapi_get_programs_programDbId(), brapi_get_programs(), brapi_get_search_lists_searchResultsDbId(), brapi_get_search_locations_searchResultsDbId(), brapi_get_search_people_searchResultsDbId(), brapi_get_search_programs_searchResultsDbId(), brapi_get_search_studies_searchResultsDbId(), brapi_get_search_trials_searchResultsDbId(), brapi_get_seasons_seasonDbId(), brapi_get_serverinfo(), brapi_get_studies_studyDbId(), brapi_get_studies(), brapi_get_studytypes(), brapi_get_trials_trialDbId(), brapi_get_trials(), brapi_post_lists_listDbId_items(), brapi_post_lists(), brapi_post_locations(), brapi_post_people(), brapi_post_programs(), brapi_post_search_lists(), brapi_post_search_locations(), brapi_post_search_people(), brapi_post_search_programs(), brapi_post_search_studies(), brapi_post_search_trials(), brapi_post_seasons(), brapi_post_studies(), brapi_post_trials(), brapi_put_lists_listDbId(), brapi_put_locations_locationDbId(), brapi_put_people_personDbId(), brapi_put_programs_programDbId(), brapi_put_seasons_seasonDbId(), brapi_put_studies_studyDbId(), brapi_put_trials_trialDbId()

Other Seasons: brapi_get_seasons_seasonDbId(), brapi_post_seasons(), brapi_put_seasons_seasonDbId()

Examples

## Not run: 
con <- brapi_db()$testserver
brapi_get_seasons(con = con)

## End(Not run)

mverouden/brapir-v2 documentation built on April 22, 2022, 9:24 a.m.