From 02ca484719f2a28f6c84ea993ad38522b9994c20 Mon Sep 17 00:00:00 2001 From: csobier Date: Thu, 26 May 2016 12:31:01 -0400 Subject: [PATCH 1/3] applied docs 781 to data observatory docs --- doc/boundary_functions.md | 8 ++++---- doc/discovery_functions.md | 6 +++--- doc/measures_functions.md | 8 ++++---- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/boundary_functions.md b/doc/boundary_functions.md index 8b614f1..d298236 100644 --- a/doc/boundary_functions.md +++ b/doc/boundary_functions.md @@ -1,8 +1,8 @@ # Boundary Functions -Use the following functions to retrieve [Boundary](/cartodb-platform/data/overview/#boundary-data) data. Data ranges from small areas (e.g. US Census Block Groups) to large areas (e.g. Countries). You can access boundaries by point location lookup, bounding box lookup, direct ID access and several other methods described below. +Use the following functions to retrieve [Boundary](/carto-engine/data/overview/#boundary-data) data. Data ranges from small areas (e.g. US Census Block Groups) to large areas (e.g. Countries). You can access boundaries by point location lookup, bounding box lookup, direct ID access and several other methods described below. -You can [access](/cartodb-platform/data/accessing/#accessing-the-data-observatory) boundaries through the CartoDB Editor. The same methods will work if you are using the CartoDB Platform to develop your application. We [encourage you](/cartodb-platform/data/accessing/#best-practices) to use table modifying methods (UPDATE and INSERT) over dynamic methods (SELECT). +You can [access](/carto-engine/data/accessing/#accessing-the-data-observatory) boundaries through the Carto Editor. The same methods will work if you are using the Carto Engine to develop your application. We [encourage you](/carto-engine/data/accessing/#best-practices) to use table modifying methods (UPDATE and INSERT) over dynamic methods (SELECT). ## OBS_GetBoundariesByGeometry(polygon geometry, geometry_id text) @@ -222,7 +222,7 @@ Insert into table `denver_census_tracts` the census tract boundaries and geom_re INSERT INTO denver_census_tracts(the_geom, geom_refs) SELECT * FROM OBS_GetBoundariesByPointAndRadius( - CDB_LatLng(39.7392, -104.9903), -- Denver, Colorado + carto_LatLng(39.7392, -104.9903), -- Denver, Colorado 10000 * 1.609, -- 10 miles (10km * conversion to miles) 'us.census.tiger.census_tract') ``` @@ -264,7 +264,7 @@ Insert into table `denver_tract_points` points on US census tracts and their cor INSERT INTO denver_tract_points(the_geom, geom_refs) SELECT * FROM OBS_GetPointsByPointAndRadius( - CDB_LatLng(39.7392, -104.9903), -- Denver, Colorado + carto_LatLng(39.7392, -104.9903), -- Denver, Colorado 10000 * 1.609, -- 10 miles (10km * conversion to miles) 'us.census.tiger.census_tract') ``` diff --git a/doc/discovery_functions.md b/doc/discovery_functions.md index 9b23589..0f2f71c 100644 --- a/doc/discovery_functions.md +++ b/doc/discovery_functions.md @@ -1,6 +1,6 @@ # Discovery Functions -If you are using the [discovery methods](/cartodb-platform/data/overview/#discovery-methods) from the Data Observatory, use the following functions to retrieve [boundary](/cartodb-platform/data/overview/#boundary-data) and [measures](/cartodb-platform/data/overview/#measures-data) data. +If you are using the [discovery methods](/carto-engine/data/overview/#discovery-methods) from the Data Observatory, use the following functions to retrieve [boundary](/carto-engine/data/overview/#boundary-data) and [measures](/carto-engine/data/overview/#measures-data) data. ## OBS_Search(search_term) @@ -47,12 +47,12 @@ A TABLE containing the following properties Key | Description --- | --- -boundary_id | a boundary identifier from the [boundary ID glossary](/cartodb-platform/data/glossary/#boundary-ids) +boundary_id | a boundary identifier from the [boundary ID glossary](/carto-engine/data/glossary/#boundary-ids) description | a brief description of the boundary dataset time_span | the timespan attached the boundary. this does not mean that the boundary is invalid outside of the timespan, but is the explicit timespan published with the geometry. #### Example ```SQL -SELECT * FROM OBS_GetAvailableBoundaries(CDB_LatLng(40.7, -73.9)) +SELECT * FROM OBS_GetAvailableBoundaries(carto_LatLng(40.7, -73.9)) ``` diff --git a/doc/measures_functions.md b/doc/measures_functions.md index a07ad93..33ebcc0 100644 --- a/doc/measures_functions.md +++ b/doc/measures_functions.md @@ -1,10 +1,10 @@ # Measures Functions -[Data Observatory Measures](/cartodb-platform/data/overview/#measures-methods) are the numerical location data you can access. The measure functions allow you to access individual measures to augment your own data or integrate in your analysis workflows. Measures are used by sending an identifier or a geometry (point or polygon) and receiving back a measure (an absolute value) for that location. +[Data Observatory Measures](/carto-engine/data/overview/#measures-methods) are the numerical location data you can access. The measure functions allow you to access individual measures to augment your own data or integrate in your analysis workflows. Measures are used by sending an identifier or a geometry (point or polygon) and receiving back a measure (an absolute value) for that location. There are hundreds of measures and the list is growing with each release. You can currently discover and learn about measures contained in the Data Observatory by downloading our [Data Catalog](https://cartodb.github.io/bigmetadata/observatory.pdf). -You can [access](/cartodb-platform/data/accessing/#accessing-the-data-observatory) measures through the CartoDB Editor. The same methods will work if you are using the CartoDB Platform to develop your application. We [encourage you](/cartodb-platform/data/accessing/#best-practices) to use table modifying methods (UPDATE and INSERT) over dynamic methods (SELECT). +You can [access](/carto-engine/data/accessing/#accessing-the-data-observatory) measures through the Carto Editor. The same methods will work if you are using the Carto Engine to develop your application. We [encourage you](/carto-engine/data/accessing/#best-practices) to use table modifying methods (UPDATE and INSERT) over dynamic methods (SELECT). ## OBS_GetUSCensusMeasure(point geometry, measure_name text) @@ -15,7 +15,7 @@ The ```OBS_GetUSCensusMeasure(point, measure_name)``` function returns a measure Name |Description --- | --- point | a WGS84 point geometry (the_geom) -measure_name | a human readable name of a US Census variable. The list of measure_names is [available in the glossary](/cartodb-platform/data/glossary/#obsgetuscensusmeasure-names-table). +measure_name | a human readable name of a US Census variable. The list of measure_names is [available in the glossary](/carto-engine/data/glossary/#obsgetuscensusmeasure-names-table). normalize | for measures that are are **sums** (e.g. population) the default normalization is 'area' and response comes back as a rate per square kilometer. Other options are 'denominator', which will use the denominator specified in the [Data Catalog](http://cartodb.github.io/bigmetadata/index.html) (optional) boundary_id | source of geometries to pull measure from (e.g., 'us.census.tiger.census_tract') time_span | time span of interest (e.g., 2010 - 2014) @@ -46,7 +46,7 @@ The ```OBS_GetUSCensusMeasure(point, measure_name)``` function returns a measure Name |Description --- | --- polygon | a WGS84 polygon geometry (the_geom) -measure_name | a human readable string name of a US Census variable. The list of measure_names is [available in the glossary](/cartodb-platform/data/glossary/#obsgetuscensusmeasure-names-table). +measure_name | a human readable string name of a US Census variable. The list of measure_names is [available in the glossary](/carto-engine/data/glossary/#obsgetuscensusmeasure-names-table). normalize | for measures that are **sums** (e.g. population) the default normalization is 'none' and response comes back as a raw value. Other options are 'denominator', which will use the denominator specified in the [Data Catalog](https://cartodb.github.io/bigmetadata/observatory.pdf) (optional) boundary_id | source of geometries to pull measure from (e.g., 'us.census.tiger.census_tract') time_span | time span of interest (e.g., 2010 - 2014) From 11b05877f4059b8fcaa62a3328ffe9fb01f81675 Mon Sep 17 00:00:00 2001 From: csobier Date: Tue, 31 May 2016 12:05:34 -0400 Subject: [PATCH 2/3] reverted rebranded code, as instruted. Legacy cartodb code instead --- doc/boundary_functions.md | 4 ++-- doc/discovery_functions.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/boundary_functions.md b/doc/boundary_functions.md index d298236..ad8c27e 100644 --- a/doc/boundary_functions.md +++ b/doc/boundary_functions.md @@ -222,7 +222,7 @@ Insert into table `denver_census_tracts` the census tract boundaries and geom_re INSERT INTO denver_census_tracts(the_geom, geom_refs) SELECT * FROM OBS_GetBoundariesByPointAndRadius( - carto_LatLng(39.7392, -104.9903), -- Denver, Colorado + CDB_LatLng(39.7392, -104.9903), -- Denver, Colorado 10000 * 1.609, -- 10 miles (10km * conversion to miles) 'us.census.tiger.census_tract') ``` @@ -264,7 +264,7 @@ Insert into table `denver_tract_points` points on US census tracts and their cor INSERT INTO denver_tract_points(the_geom, geom_refs) SELECT * FROM OBS_GetPointsByPointAndRadius( - carto_LatLng(39.7392, -104.9903), -- Denver, Colorado + CDB_LatLng(39.7392, -104.9903), -- Denver, Colorado 10000 * 1.609, -- 10 miles (10km * conversion to miles) 'us.census.tiger.census_tract') ``` diff --git a/doc/discovery_functions.md b/doc/discovery_functions.md index 0f2f71c..2daf657 100644 --- a/doc/discovery_functions.md +++ b/doc/discovery_functions.md @@ -54,5 +54,5 @@ time_span | the timespan attached the boundary. this does not mean that the boun #### Example ```SQL -SELECT * FROM OBS_GetAvailableBoundaries(carto_LatLng(40.7, -73.9)) +SELECT * FROM OBS_GetAvailableBoundaries(CDB_LatLng(40.7, -73.9)) ``` From a18b07fa849b8f589e7c3398dd0d748b89c8e9a7 Mon Sep 17 00:00:00 2001 From: csobier Date: Tue, 31 May 2016 12:33:15 -0400 Subject: [PATCH 3/3] rebranded name must appear in ALL CAPS --- doc/boundary_functions.md | 2 +- doc/measures_functions.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/boundary_functions.md b/doc/boundary_functions.md index ad8c27e..9621455 100644 --- a/doc/boundary_functions.md +++ b/doc/boundary_functions.md @@ -2,7 +2,7 @@ Use the following functions to retrieve [Boundary](/carto-engine/data/overview/#boundary-data) data. Data ranges from small areas (e.g. US Census Block Groups) to large areas (e.g. Countries). You can access boundaries by point location lookup, bounding box lookup, direct ID access and several other methods described below. -You can [access](/carto-engine/data/accessing/#accessing-the-data-observatory) boundaries through the Carto Editor. The same methods will work if you are using the Carto Engine to develop your application. We [encourage you](/carto-engine/data/accessing/#best-practices) to use table modifying methods (UPDATE and INSERT) over dynamic methods (SELECT). +You can [access](/carto-engine/data/accessing/#accessing-the-data-observatory) boundaries through the CARTO Editor. The same methods will work if you are using the CARTO Engine to develop your application. We [encourage you](/carto-engine/data/accessing/#best-practices) to use table modifying methods (UPDATE and INSERT) over dynamic methods (SELECT). ## OBS_GetBoundariesByGeometry(polygon geometry, geometry_id text) diff --git a/doc/measures_functions.md b/doc/measures_functions.md index 33ebcc0..a08406e 100644 --- a/doc/measures_functions.md +++ b/doc/measures_functions.md @@ -4,7 +4,7 @@ There are hundreds of measures and the list is growing with each release. You can currently discover and learn about measures contained in the Data Observatory by downloading our [Data Catalog](https://cartodb.github.io/bigmetadata/observatory.pdf). -You can [access](/carto-engine/data/accessing/#accessing-the-data-observatory) measures through the Carto Editor. The same methods will work if you are using the Carto Engine to develop your application. We [encourage you](/carto-engine/data/accessing/#best-practices) to use table modifying methods (UPDATE and INSERT) over dynamic methods (SELECT). +You can [access](/carto-engine/data/accessing/#accessing-the-data-observatory) measures through the CARTO Editor. The same methods will work if you are using the CARTO Engine to develop your application. We [encourage you](/carto-engine/data/accessing/#best-practices) to use table modifying methods (UPDATE and INSERT) over dynamic methods (SELECT). ## OBS_GetUSCensusMeasure(point geometry, measure_name text)