cartodb4/dataservices-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

first changes

Browse Source
This commit is contained in:
andrewxhill 2016-05-11 09:45:02 -04:00
parent 8c6318e25d
commit d745ba2ae7
2 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/demographic_functions.md
View File

@ -1,10 +1,10 @@
# Demographic Functions # Demographic Functions
The Demographic Snapshot functions enable you to collect demographic details around a point location. For example, you can take the coordinates of a coffee shop and find the average population characteristics around that location. If you need help creating coordinates from addresses, see the [Geocoding Functions](/cartodb-platform/dataservices-api/geocoding-functions/) documentation. The Demographic Snapshot enables you to collect demographic report around a point location. For example, you can take the coordinates of a coffee shop and find the average population characteristics such as total population, educational attainment, housing and income information around that location. You can use raw street addresses by combining the Demographic Snapshot with CartoDB's geocoding features. If you need help creating coordinates from addresses, see the [Geocoding Functions](/cartodb-platform/dataservices-api/geocoding-functions/) documentation.
_**Note:** The Demographic Snapshot functions are only available for the United States._ _**Note:** The Demographic Snapshot functions are only available for the United States._
## OBS_GetDemographicSnapshot( Point Geometry ); ## OBS_GetDemographicSnapshot( point geometry );
Fields returned include information about income, education, transportation, race, and more. Not all fields will have information for every coordinate queried. Fields returned include information about income, education, transportation, race, and more. Not all fields will have information for every coordinate queried.
@ -17,7 +17,9 @@ point geometry | A WKB point geometry. You can use the helper function, `CDB_Lat
### Returns ### Returns
The Demographic Snapshot contains a broad subset of demographic measures in the Data Observatory. Over 80 measurements are returned by a single API request. **For details, see [Glossary of Demographic Measures](#glossary-of-demographic-measures). The Demographic Snapshot contains a broad subset of demographic measures in the Data Observatory. Over 80 measurements are returned by a single API request. *
**For details, see [Glossary of Demographic Measures](#glossary-of-demographic-measures) below.**
### Examples ### Examples
@ -50,11 +52,11 @@ This list contains the demographic measures and reponse names for results from t
Measure name | Measure Description | Response Mame | Response Units Measure name | Measure Description | Response Mame | Response Units
--- | --- | --- | --- --- | --- | --- | ---
Total Population | The total number of all people living in a given geographic area. This is a very useful catch-all denominator when calculating rates. | total_pop | Count per sq. km Total Population | The total number of all people living in a given geographic area. This is a very useful catch-all denominator when calculating rates. | total_pop | Count per sq. km
Male Population | The number of people within each geography who are male. | male_pop | Count per sq. km Male Population | The number of people within each geography who are male. | male_pop | Count per sq. km
Female Population | The number of people within each geography who are female.| female_pop | Count per sq. km Female Population | The number of people within each geography who are female.| female_pop | Count per sq. km
Population not Hispanic | The number of people not identifying as Hispanic or Latino in each geography. | not_hispanic_pop | Count per sq. km Population not Hispanic | The number of people not identifying as Hispanic or Latino in each geography. | not_hispanic_pop | Count per sq. km
White Population | The number of people identifying as white, non-Hispanic in each geography. | white_pop | Count per sq. km White Population | The number of people identifying as white, non-Hispanic in each geography. | white_pop | Count per sq. km
Black or African American Population| The number of people identifying as black or African American, non-Hispanic in each geography. | black_pop | Count per sq. km Black or African American Population| The number of people identifying as black or African American, non-Hispanic in each geography. | black_pop | Count per sq. km
American Indian and Alaska Native Population | The number of people identifying as American Indian or Alaska native in each geography.| amerindian_pop| Count per sq. km American Indian and Alaska Native Population | The number of people identifying as American Indian or Alaska native in each geography.| amerindian_pop| Count per sq. km
Asian Population | The number of people identifying as Asian, non-Hispanic in each geography.| asian_pop | Count per sq. km Asian Population | The number of people identifying as Asian, non-Hispanic in each geography.| asian_pop | Count per sq. km

4
doc/segmentation_functions.md
View File

@ -1,8 +1,8 @@
# Segmentation Functions # Segmentation Functions
The Segmentation Snapshot functions enable you to determine the pre-calculated population segment for a location. Segmentation is a method that divides a target market into subgroups based on shared common traits. For example, you can take the location of a store location and determine what classification of population exists around that location. If you need help creating coordinates from addresses, see the [Geocoding Functions](/cartodb-platform/dataservices-api/geocoding-functions/) documentation. The Segmentation Snapshot functions enable you to determine the pre-calculated population segment for a location. Segmentation is a method that divides a populations into subclassifications based on common traits. For example, you can take the a store location and determine what classification of population exists around that location. If you need help creating coordinates from addresses, see the [Geocoding Functions](/cartodb-platform/dataservices-api/geocoding-functions/) documentation.
_**Note:** The Segmentation Snapshot functions are only available for the United States. CartoDB includes the segmentation profile defined in the Output Data: US_tract_clusters_new_, as detailed in the _[Understanding America's Neighborhoods Using Uncertain Data from the American Community Survey](http://www.tandfonline.com/doi/pdf/10.1080/00045608.2015.1052335) contextual approach. Subsequent releases will include additional segmentation profiles._ _**Note:** The Segmentation Snapshot functions are only available for the United States. Our first release (May 18, 2016) is derived from Census 2010 variables. Our next release will be based on Census 2014 data. For the latest information, see the [Open Segments](https://github.com/CartoDB/open-segments) project repository._
## OBS_GetSegmentationSnapshot( Point Geometry ); ## OBS_GetSegmentationSnapshot( Point Geometry );