Skip to content

Commit 5fb05bb

Browse files
committed
Add neighborhood csv instructions README
1 parent cf2c28b commit 5fb05bb

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

neighborhood_data/README.txt

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
NEIGHBORHOOD DATA SUBMISSION INSTRUCTIONS
2+
============================
3+
4+
File name: neighborhoods.csv
5+
Encoding: UTF-8
6+
Delimiter: Comma (,)
7+
Header row: Required (do not modify column names)
8+
Do not add or remove columns.
9+
Can add new neighborhood rows.
10+
Do not remove rows, if no longer have data for neighborhood please inform us to remove Neighborhood across our datasets.
11+
12+
COLUMN SPECIFICATION
13+
====================
14+
15+
Column | Type | Required | Allowed Values / Notes
16+
------------------------------|-------------------------------|----------|-----------------------------------------------
17+
town | Text | Yes |
18+
zipcode | Number | Yes |
19+
ecc | Number | Yes | Booleans expressed as integers (0 = False, non-zero = True)
20+
violentcrime_quintile | Number | Yes | 1–5 (5 = Worst, 1 = Best)
21+
education_percentile_quintile | Number | Yes | 1–5 (5 = Worst, 1 = Best)
22+
education_percentile | Number or "School Choice" | Yes | 0–100 (0 = Worst, 100 = Best); "School Choice" accepted
23+
school_choice | Number | Yes | Booleans expressed as integers (0 = False, non-zero = True)
24+
total_mapc | Number | Yes |
25+
house_number_symbol | Number | Yes |
26+
lat_lon_category | Number | Yes |
27+
lat | Number | Yes |
28+
lon | Number | Yes |
29+
town_website_description | Text | No |
30+
town_link | Text | No | Valid town URL
31+
wikipedia | Text | No |
32+
wikipedia_link | Text | No | Valid town Wikipedia URL
33+
street | Text | No | Valid image link
34+
school | Text | No | Valid image link
35+
town_square | Text | No | Valid image link
36+
open_space_or_landmark | Text | No | Valid image link
37+
crime_percentile | Number | Yes | 0–100 (0 = Worst, 100 = Best)
38+
max_rent_0br | Number | Yes |
39+
max_rent_1br | Number | Yes |
40+
max_rent_2br | Number | Yes |
41+
max_rent_3br | Number | Yes |
42+
max_rent_4br | Number | Yes |
43+
max_rent_5br | Number | Yes |
44+
max_rent_6br | Number | Yes |
45+
town_area | Text | No | "Boston" or "Cambridge"
46+
family_move_count | Number | Yes |
47+
region | Text | Yes | "North Shore", "Metro West", "Boston and Greater Boston", "South Shore"

0 commit comments

Comments
 (0)