malariagen_data.ag3.Ag3.cohorts

Ag3.cohorts(cohort_set: str | Mapping[str, str]) → DataFrame

Read data for a specific cohort set, including cohort size, country code, taxon, administrative units name, ISO code, geoBoundaries shape ID and representative latitude and longitude points.

Parameters

cohort_setstr or Mapping[str, str]

A cohort set name. Accepted values are: “admin1_month”, “admin1_quarter”, “admin1_year”, “admin2_month”, “admin2_quarter”, “admin2_year”.

Returns

DataFrame

A dataframe of cohort data, one row per cohort. There are up to 18 columns: cohort_id is the identifier of the cohort, cohort_size is the number of samples in the cohort, country is the country the cohort is from, country_alpha2 is the ISO alpha-2 code for the country the cohort is from, country_alpha3 is the ISO alpha-3 code for the country the cohort is from, taxon is the taxon of the samples in the cohort, year is the year the samples in the cohort were collected in, quarter is the quarter the samples in the cohort were collected in (this column is only present if the temporal dimension is quarter or month), month is the month the samples in the cohort were collected in (this column is only present if the temporal dimension is month), admin1_name is the name of the first administrative level the samples in the cohort were collected in, admin1_iso is the ISO code of the first administrative level the samples in the cohort were collected in, admin1_geoboundaries_shape_id is the identifier of the geoboundary shape corresponding to the first administrative level the samples in the cohort were collected in, admin1_representative_longitude is the representative longitude for the first administrative level the samples in the cohort were collected in, admin1_representative_latitude is the representative latitude for the first administrative level the samples in the cohort were collected in, admin2_name is the name of the second administrative level the samples in the cohort were collected in (this column is only present if the spatial dimension is admin2), admin2_iso is the ISO code of the second administrative level the samples in the cohort were collected in (this column is only present if the spatial dimension is admin2), admin2_geoboundaries_shape_id is the identifier of the geoboundary shape corresponding to the second administrative level the samples in the cohort were collected in (this column is only present if the spatial dimension is admin2), admin2_representative_longitude is the representative longitude for the second administrative level the samples in the cohort were collected in (this column is only present if the spatial dimension is admin2), admin2_representative_latitude is the representative latitude for the second administrative level the samples in the cohort were collected in (this column is only present if the spatial dimension is admin2).