added data descriptions

README.md

@@ -40,43 +40,44 @@ This dataset has many potential uses. Primarily, visualization of plays, as illu
 
 The data is in the following dictionary format:
 
-- 'gameid': str
-- 'gamedate': str
-- 'event_info':
-  - 'eventid': str
-  - 'type': int
-  - 'possession_team_id': float
-  - 'desc_home': str
-  - 'desc_away': str
+- 'gameid': str (ID for the game)
+- 'gamedate': str (date the game occured on)
+- 'event_info': 
+  - 'eventid': str (ID for the event in the given game)
+  - 'type': int (number corresponding to event type)
+  - 'possession_team_id': float (team ID of team in possession during the event)
+  - 'desc_home': str (description of the event for the home team)
+  - 'desc_away': str (description of the event for the away team)
 - 'primary_info':
-  - 'team': str
-  - 'player_id': float
-  - 'team_id': float
-- 'secondary_info': same format as primary info
+  - 'team': str (home or visitor)
+  - 'player_id': float (ID of primary player involved in event)
+  - 'team_id': float (ID of team for primary player)
+- 'secondary_info': same format as primary info, but for a secondary player involved
 - 'visitor':
-  - 'name': str
-  - 'teamid': int,
-  - 'abbreviation': str
+  - 'name': str (team name)
+  - 'teamid': int (team ID)
+  - 'abbreviation': str (abbreviation of team name)
   - 'players': list of the dictionaries in the form of the following
-    - 'lastname': str
-    - 'firstname': str
-    - 'playerid': str
-    - 'number': int
-    - 'position': str
+    - 'lastname': str (player last name)
+    - 'firstname': str (player first name)
+    - 'playerid': str (player ID)
+    - 'number': int (player jersey number)
+    - 'position': str (player in-game position)
 - 'home': same format as visitor
-- 'quarter': int
-- 'game_clock': float
-- 'shot_clock': float
-- 'ball_coordinates':
-  - 'x': float
-  - 'y': float
-  - 'z': float
-- 'player_coordinates': list of the dictionaries in the form of the following
-  - 'teamid': int
-  - 'playerid': int
-  - 'x': float
-  - 'y': float
-  - 'z': float
+- 'moments': list of dictionaries in the form of the following
+  - 'quarter': int (quarter of moment)
+  - 'game_clock': float (game clock (seconds, descending starting from 720))
+  - 'shot_clock': float (shot clock (seconds, descending starting from 24))
+  - 'ball_coordinates':
+    - 'x': float (x coordinate of ball)
+    - 'y': float (y coordinate of ball)
+    - 'z': float (z coordinate of ball)
+  - 'player_coordinates': list of the dictionaries in the form of the following, 
+    - 'teamid': int (team ID of player)
+    - 'playerid': int (player ID for player)
+    - 'x': float (x coordinate of player)
+    - 'y': float (y coordinate of player)
+    - 'z': float (z coordinate of player)
 
 ## Requirements