Update README.md

README.md

@@ -16,12 +16,14 @@ size_categories:
 
 ## Dataset Details
 
-### Dataset Description
-
 The Reddit Climate Comment dataset focuses on comments from subreddits intricately linked to discussions on climate change, energy, and specifically renewable energy. Utilizing the Reddit API, we extract insights from the top ~1000 posts in key subreddits, including "Climate," "Energy," "RenewableEnergy", and “ClimateChange”, providing a nuanced exploration of conversations surrounding these crucial environmental sustainability topics.
 
+### Dataset Description
+
 The dataset is centered around discussions related to clean energy and climate change, obtained through the Reddit API by extracting information from the top ~900 to ~1000 posts within specified subreddits and collected using a Python Library, Praw, on January 31th, 2024, code shown in Appendix. These subreddits include “Climate”, “Energy”, “RenewableEnergy”, and “ClimateChange”. The dataset collected 20 comments under each post. The selection of curated subreddit names is determined by assessing both the relevance of the subreddit to energy and climate change and the size of the subreddit community, measured by the number of Reddit users who have joined. In the dataset, under the “Climate” subreddit category, there are 14,003 comments (184k users in the community), while 10,465 comments under “ClimateChange” subreddit category (89k users in the community); “Energy” subreddit has 13,692 comments (181k users in the community), and the “RenewableEnergy” subreddit has 5,394 comments (124k users in the community). In total, there are 43,554 comments across all subreddit. During the data collection process, timestamps were converted from Unix timestamps (seconds since the epoch) in the raw data into a UTC datetime object.
 
+Our dataset includes information from ~20 comments under each of the top 1000 posts, providing a detailed lens into user engagement and sentiment within these subreddits. Subreddit names are curated with consideration for relevance to climate and energy topics, and the number of users in a community. This ensures a diverse representation of opinions and perspectives. While the primary emphasis is on clean energy discussions, the inclusion of "Energy", "Climate", and “ClimateChange” subreddits introduces valuable comparative dimensions. "Energy" provides insights into the broader energy landscape, while "climate" and “climatechange” reflect overarching perspectives and attitudes towards sustainability subjects. The dataset, thus, serves as a comprehensive repository for exploring nuanced discussions on Reddit surrounding climate, energy, and renewable energy topics.
+
 - **Curated by:** Reddit users and the Reddit platform
 - **Language(s):** English
 - **License:** MIT
@@ -33,13 +35,16 @@ The dataset is centered around discussions related to clean energy and climate c
 
 ## Uses
 
-<!-- Address questions around how the dataset is intended to be used. -->
+The Reddit Climate Comment dataset is intended to be used for various natural language processing (NLP) and text-based analyses related to discussions on climate change, energy, and renewable energy topics.
 
 ### Direct Use
 
-<!-- This section describes suitable use cases for the dataset. -->
-
-[More Information Needed]
+1. Sentiment Analysis: determine the sentiment expressed in comments related to climate, energy, and renewable energy.
+2. Topic Modeling: identify prevalent topics and themes within the discussions.
+3. Keyword Extraction: extract keywords or phrases that frequently appear in the dataset to understand the most discussed concepts within climate, energy, and renewable energy discussions
+4. User Engagement Analysis: explore user engagement metrics, such as upvotes and comment length, to discern patterns in community participation and preferences.
+5. Comparative Analysis: conduct comparative analyses between discussions in subreddits focused on "energy", "renewable energy", "climate", and “climatechange”. Explore how conversations differ across these thematic areas.
+6. Temporal Analysis: investigate how discussions evolve by analyzing temporal patterns. Identify trends, peak activity periods, and correlations with real-world events.
 
 ### Out-of-Scope Use
 
@@ -59,6 +64,7 @@ It's essential for users of the dataset to exercise caution, critically evaluate
 
 The organized dataset is structured in a hierarchical array format to facilitate efficient navigation and analysis of comments within specific subreddits, post titles, and post IDs. Each element in the array represents a subreddit community, containing information about individual posts within that subreddit.
 
+This representation includes a sample post from the "climate" subreddit with two comments. Huggingface dataset users can adjust the data fields and content according to desired actual dataset structure. This format helps users understand the structure and content of the dataset in a standardized way, which is suitable for Hugging Face datasets.
 ```json
 {
   "dataset": "Reddit Climate Comment",
@@ -81,6 +87,19 @@ The organized dataset is structured in a hierarchical array format to facilitate
   ]
 }
 ```
+The dataset includes the following fields:
+
+```json
+Subreddit (String): represents the name of the subreddit community where discussions are taking place (e.g., "climate").
+  Posts (Array): contains information about individual posts within the subreddit.
+  PostID (Integer): original post identifier.
+  PostTitle (String): title of the Reddit post, summarizing the topic of discussion.
+    Comments (Array):contains individual comments associated with the post.
+    Author (String): username of the comment author.
+    CommentBody (String): the text content of the comment.
+    Timestamp (String): timestamp indicating when the comment was created (in UTC).
+    Upvotes (Integer): number of upvotes received for the comment.
+```
 
 ## Dataset Creation