Update README.md

This commit is contained in:
Carla 2015-06-24 18:20:15 +02:00
parent d500a2cf63
commit decda55a98

View File

@ -9,31 +9,67 @@ By following the next steps a table is populated with zipcodes from Australia, C
## Creation steps
1. Import the four files attached in the section "Datasources".
1. Import the four files attached in the section "Datasources" for Australia (`doc` table), Canada (`gfsa000a11a_e` table), USA (`tl_2013_us_zcta510` table) and France (`codes_postaux` table).
2. Run `sql/build_data_table.sql`. Notice that table `postal_code_polygons` should exist in advance with columns: `the_geom`, `adm0_a3` and `postal_code`.
## Tables
### postal_code_polygons
#### Table structure
````
Table "public.postal_code_polygons"
Column | Type | Modifiers | Storage | Stats target | Description
----------------------+--------------------------+-----------------------------------------------------------------------+----------+--------------+-------------
cartodb_id | integer | not null default nextval('untitled_table_2_cartodb_id_seq'::regclass) | plain | |
postal_code | text | | extended | |
adm0_a3 | text | | extended | |
created_at | timestamp with time zone | not null default now() | plain | |
updated_at | timestamp with time zone | not null default now() | plain | |
the_geom | geometry(Geometry,4326) | | main | |
the_geom_webmercator | geometry(Geometry,3857) | | main | |
````
#### Current indexes
````
Indexes:
"untitled_table_2_pkey" PRIMARY KEY, btree (cartodb_id)
"idx_postal_code_polygons_a3_code" UNIQUE, btree (adm0_a3, postal_code)
"untitled_table_2_the_geom_idx" gist (the_geom)
"untitled_table_2_the_geom_webmercator_idx" gist (the_geom_webmercator)
````
## Related functions
### geocode_postalcode_polygons
````
Schema | Name | Result data type | Argument data types | Type
--------+-----------------------------+-------------------------------------+---------------------------------------+--------
public | geocode_postalcode_polygons | SETOF geocode_postalint_country_v1 | code integer[], inputcountries text[] | normal
public | geocode_postalcode_polygons | SETOF geocode_namedplace_v1 | code text[] | normal
public | geocode_postalcode_polygons | SETOF geocode_namedplace_country_v1 | code text[], inputcountries text[] | normal
public | geocode_postalcode_polygons | SETOF geocode_namedplace_v1 | code text[], inputcountry text | normal
`````
### test_geocode_postalcode_polygons
````
Schema | Name | Result data type | Argument data types | Type
--------+----------------------------------+-------------------------------------+------------------------------------+--------
public | test_geocode_postalcode_polygons | SETOF geocode_namedplace_country_v1 | code text[], inputcountries text[] | normal
public | test_geocode_postalcode_polygons | SETOF geocode_namedplace_v1 | code text[], inputcountry text | normal
`````
2. Run sql/build_data_table.sql. Notice that table "postal_code_polygons" should exist in advance with columns: _the_geom_, _adm0_a3_ and _postal_code_.
## Data Sources
Australian polygons - http://www.abs.gov.au/AUSSTATS/abs@.nsf/DetailsPage/2033.0.55.0012011?OpenDocument
Download the KMZ for *Postal Area IRSD, SEIFA 2011*. Unzip and upload the kmz
* Australian polygons - http://www.abs.gov.au/AUSSTATS/abs@.nsf/DetailsPage/2033.0.55.0012011?OpenDocument - Download the KMZ for *Postal Area IRSD, SEIFA 2011*. Unzip and upload the kmz
Canadian polygons - http://www12.statcan.gc.ca/census-recensement/2011/geo/bound-limit/bound-limit-2011-eng.cfm
Download ESRI Shp, Forward Sortation Areas, Digital Boundary
* Canadian polygons - http://www12.statcan.gc.ca/census-recensement/2011/geo/bound-limit/bound-limit-2011-eng.cfm - Download ESRI Shp, Forward Sortation Areas, Digital Boundary
USA polygons - http://www2.census.gov/geo/tiger/TIGER2013/ZCTA5/tl_2013_us_zcta510.zip
* USA polygons - http://www2.census.gov/geo/tiger/TIGER2013/ZCTA5/tl_2013_us_zcta510.zip
French polygons - http://www.data.gouv.fr/dataset/fond-de-carte-des-codes-postaux
## Preparation details
The names of the imported files are:
- doc for Australia table
- gfsa000a11a_e for Canada table
- tl_2013_us_zcta510 for USA table
- codes_postaux for France table
* French polygons - http://www.data.gouv.fr/dataset/fond-de-carte-des-codes-postaux
# Postal code geocoder: Points
@ -54,19 +90,18 @@ MH, RO, FO, GF, AD, HR, DZ, GT, AU, AS, BE, AT
1. Download the allCountries.zip file from [GeoNames](www.geonames.org). Import and rename the table as tmp_zipcode_points. You can follow the manual process explained below instead.
The columns that are loaded are the following ones:
field_1: corresponding to ISO2
field_10: corresponds to latitude
field_11: corresponds to longitude
field_2: corresponds to ZIP code
The columns that are loaded are the following ones:
field_1: corresponding to ISO2
field_10: corresponds to latitude
field_11: corresponds to longitude
field_2: corresponds to ZIP code
2. Georeference the table using field11 as longitude and field10 as latitude in order to construct the_geom.
3. Add column iso3 (text) and run sql/build_zipcode_points_table.sql.
**Alternative manual process**
**Alternative manual process for importing and preprocessing**
Open the allCountries.txt file with Excel an add a new row on top. Delete columns C-I and L.
@ -74,13 +109,42 @@ In the first row, add the following columns: iso2, zipcode, lat, long.
Import the file ignoring step 2.
## Tables
### postal_code_points
#### Table structure
````
Table "public.postal_code_points"
Column | Type | Modifiers | Storage | Stats target | Description
----------------------+--------------------------+------------------------------------------------------------------------+----------+--------------+-------------
cartodb_id | integer | not null default nextval('untitled_table_2_cartodb_id_seq2'::regclass) | plain | |
adm0_a3 | text | | extended | |
postal_code | text | | extended | |
created_at | timestamp with time zone | not null default now() | plain | |
updated_at | timestamp with time zone | not null default now() | plain | |
the_geom | geometry(Geometry,4326) | | main | |
the_geom_webmercator | geometry(Geometry,3857) | | main | |
````
#### Current indexes
````
"untitled_table_2_pkey2" PRIMARY KEY, btree (cartodb_id)
"untitled_table_2_the_geom_idx2" gist (the_geom)
"untitled_table_2_the_geom_webmercator_idx2" gist (the_geom_webmercator)
````
## Related functions
### geocode_postalcode_points
````
Schema | Name | Result data type | Argument data types | Type
--------+---------------------------+------------------------------------+---------------------------------------+--------
public | geocode_postalcode_points | SETOF geocode_postalint_country_v1 | code integer[], inputcountries text[] | normal
public | geocode_postalcode_points | SETOF geocode_namedplace_v1 | code text[] | normal
public | geocode_postalcode_points | SETOF geocode_place_country_iso_v1 | code text[], inputcountries text[] | normal
public | geocode_postalcode_points | SETOF geocode_namedplace_v1 | code text[], inputcountry text | normal
`````
## Data Sources
All countries points [GeoNames](www.geonames.org) - http://download.geonames.org/export/zip/allCountries.zip
## Preparation details
_The big size of the dataset may cause interruptions in the processing of the coordinates after uploading the file, manipulating the file before importing is a faster workaround._
* All countries points [GeoNames](www.geonames.org) - http://download.geonames.org/export/zip/allCountries.zip
# Known issues:
* The name of the countries added in a column are not being sanitized https://github.com/CartoDB/cartodb/issues/3392