hollyyfc commited on
Commit
7488732
1 Parent(s): 7ea918e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +15 -10
README.md CHANGED
@@ -41,7 +41,11 @@ This dataset scrapes TidyTuesday datasets from 2023-2024, aiming to make resourc
41
 
42
  ## Dataset Structure
43
 
44
- The dataset is stored in a JSON nested, hierarchical structure. Refer below for a detailed depiction of the variable organization.
 
 
 
 
45
 
46
  ### Data Instances
47
 
@@ -89,15 +93,16 @@ The dataset is stored in a JSON nested, hierarchical structure. Refer below for
89
 
90
  ### Data Fields
91
 
92
- - `date_posted`: The date when the weekly project was posted *(YYYY-MM-DD str)*.
93
- - `project_name`: The name of the weekly project *(str)*.
94
- - `project_source`: A list of URLs to the project's data and information source *(List[str])*.
95
- - `description`: A brief excerpt of the project and dataset description *(str)*.
96
- - `data_source_url`: The URL to the weekly project repository *(str)*.
97
- - `data_dictionary`: A list of dictionaries, each containing the variable names, classes, and descriptions for each dataset *(List[Dict[str: List[str]]])*.
98
- - `data`: A dictionary of dataset names and links to view. The values of the keys `file_name` and `file_url` are organized in list fashion.
99
- - `data_load`: A dictionary of dataset names and links to direct download. The values of the keys `file_name` and `file_url` are organized in list fashion *(Dict[str: List[str]])*.
100
-
 
101
 
102
  ## Dataset Creation
103
 
 
41
 
42
  ## Dataset Structure
43
 
44
+ The dataset is stored in both JSON nested hierarchical structure and CSV format.
45
+
46
+ - Full set: "full" in loaded datasets | `tidytuesday_json.json` and `tidytuesday_2023_2024.csv` on GitHub
47
+ - Train set: "train" in loaded datasets | `tidytuesday_json_train.json` and `tidytuesday_train.csv` on GitHub
48
+ - Validation set: "validation" in loaded datasets | `tidytuesday_json_val.json` and `tidytuesday_val.csv` on GitHub
49
 
50
  ### Data Instances
51
 
 
93
 
94
  ### Data Fields
95
 
96
+ | **Key / Variable** | **Type** | **Description** |
97
+ |--------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
98
+ | `date_posted` | *str* | The date when the weekly project was posted _(YYYY-MM-DD)_ |
99
+ | `project_name` | *str* | The name of the weekly project |
100
+ | `project_source` | *List[str]* | A list of URLs to the project's data and information source |
101
+ | `description` | *str* | A brief excerpt of the project and dataset description |
102
+ | `data_source_url` | *str* | The URL to the weekly project repository |
103
+ | `data_dictionary` | *List[Dict[str: List[str]]]* | A list of dictionaries, each containing the variable names, classes, and descriptions for each dataset |
104
+ | `data` | *Dict[str: List[str]]* | A dictionary of dataset names and links to view. The values of the keys `file_name` and `file_url` are organized in list fashion |
105
+ | `data_load` | *Dict[str: List[str]]* | A dictionary of dataset names and links to direct download. The values of the keys `file_name` and `file_url` are organized in list fashion |
106
 
107
  ## Dataset Creation
108