From 8c6318e25da1b17927f955d142cc502f16086858 Mon Sep 17 00:00:00 2001 From: csobier Date: Mon, 9 May 2016 08:36:05 -0400 Subject: [PATCH] removed comments about function signature, changed code to appear correctly in output --- doc/demographic_functions.md | 11 ++++------- doc/segmentation_functions.md | 12 +++++------- 2 files changed, 9 insertions(+), 14 deletions(-) diff --git a/doc/demographic_functions.md b/doc/demographic_functions.md index dd5644b..522d216 100644 --- a/doc/demographic_functions.md +++ b/doc/demographic_functions.md @@ -1,13 +1,11 @@ # Demographic Functions -The Demographic Snapshot API function enables 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 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. -_**Note:** The Demographic Snapshot API is currently only available for the United States._ +_**Note:** The Demographic Snapshot functions are only available for the United States._ ## OBS_GetDemographicSnapshot( Point Geometry ); -<<<<<<<<**PLEASE CONFIRM NAME, SPACING IN THE ACTUAL DATASERVICES API CODE APPEARS DIFFERENTLY FOR THIS FUNCTION?**>>>>>>>> - Fields returned include information about income, education, transportation, race, and more. Not all fields will have information for every coordinate queried. ### Arguments @@ -23,7 +21,7 @@ The Demographic Snapshot contains a broad subset of demographic measures in the ### Examples -```html +```bash https://{{username}}.cartodb.com/api/v2/sql?q=SELECT * FROM OBS_GetDemographicSnapshot({{point geometry}}) ``` @@ -41,9 +39,8 @@ OBS_GetDemographicSnapshot(CDB_LatLng(39.648333, -77.465)) __Get the Demographic Snapshot in the Upper West Side__ -```text +```bash https://{username}.cartodb.com/api/v2/sql?q=SELECT * FROM - OBS_GetDemographicSnapshot(CDB_LatLng(40.80, -73.960)) ``` diff --git a/doc/segmentation_functions.md b/doc/segmentation_functions.md index 6d73d39..5960a10 100644 --- a/doc/segmentation_functions.md +++ b/doc/segmentation_functions.md @@ -1,13 +1,11 @@ # Segmentation Functions -The Segmentation Snapshot API function enables 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 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. -_**Note:** The Segmentation Snapshot API is currently 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. 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._ ## OBS_GetSegmentationSnapshot( Point Geometry ); -<<<<<<<<**PLEASE CONFIRM NAME, SPACING IN THE ACTUAL DATASERVICES API CODE APPEARS DIFFERENTLY FOR THIS FUNCTION?**>>>>>>>> - ### Arguments Name | Type | Description | Example Values @@ -26,7 +24,7 @@ __todo__ ### Examples -```html +```bash https://{{username}}.cartodb.com/api/v2/sql?q=SELECT * FROM OBS_GetSegmentationSnapshot({{point geometry}}) ``` @@ -36,7 +34,7 @@ OBS_GetSegmentationSnapshot({{point geometry}}) __Get the Segmentation Snapshot around the MGM Grand__ -```text +```bash https://{username}.cartodb.com/api/v2/sql?q=SELECT * FROM OBS_GetSegmentationSnapshot(CDB_LatLng(36.10222, -115.169516)) ``` @@ -44,7 +42,7 @@ OBS_GetSegmentationSnapshot(CDB_LatLng(36.10222, -115.169516)) __Get the Segmentation Snapshot at CartoDB's NYC HQ__ -```text +```bash https://{username}.cartodb.com/api/v2/sql?q=SELECT * FROM OBS_GetSegmentationSnapshot(CDB_LatLng(40.704512, -73.936669)) ```