Update README.md

README.md

@@ -16,18 +16,11 @@ size_categories:
 
 ## Dataset Description
 
-### Dataset Details
-
 The Reddit Climate Comment dataset is a collection of comments extracted from subreddits focused on discussions related to climate change, energy, and renewable energy. It includes comments from popular subreddits such as "Climate," "Energy," "RenewableEnergy," and “ClimateChange”. The dataset provides insights into user engagement, sentiment, and discussions surrounding environmental sustainability topics on Reddit. It was created using the Reddit API, with comments collected from the top posts in selected subreddits, totaling 44,109 comments. The dataset encompasses discussions in English language and serves as a comprehensive resource for natural language processing (NLP) and text-based analyses in the domain of climate change and energy.
 
-### Dataset Description
-
-[reddit_data_collection.py](https://huggingface.co/datasets/cathw/reddit_climate_comment/blob/main/reddit_data_collection.py))
-
-
-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.
+### Dataset Details
 
-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.
+The dataset is centered around discussions related to clean energy and climate change, obtained through the Reddit API by extracting information from the top 1000 posts within specified subreddits and collected using a Python Library, Praw, on January 31th, 2024, code shown in [reddit_data_collection.py](https://huggingface.co/datasets/cathw/reddit_climate_comment/blob/main/reddit_data_collection.py). 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,008 comments (184k users in the community), while 10,963 comments under “ClimateChange” subreddit category (89k users in the community); “Energy” subreddit has 13,741 comments (181k users in the community), and the “RenewableEnergy” subreddit has 5,397 comments (124k users in the community). In total, there are 44,109 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.
 
 - **Curated by:** Reddit users and the Reddit platform
 - **Language(s):** English
@@ -37,32 +30,29 @@ Our dataset includes information from ~20 comments under each of the top 1000 po
 
 - **API Documentation:** [https://www.reddit.com/dev/api/]
 
-## Uses
+### Supported Tasks
 
 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
+Supported tasks include:
 
 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.
+2. Topic Modeling: identify prevalent topics and themes within the energy and climate 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
-
-While the Reddit Climate Comment dataset offers valuable insights into discussions surrounding climate change, energy, and renewable energy topics on Reddit, there are certain out-of-scope uses and limitations to consider:
+### Languages
 
-1. Individual Identification: The dataset should not be used for identifying or targeting individual Reddit users based on their comments. The dataset does not provide personally identifiable information about users, and any attempt to infer or extract such information would constitute misuse.
+The Reddit Climate Comment dataset primarily contains discussions in the English language. As Reddit is predominantly an English-language platform, the dataset mainly consists of comments written in standard English. However, it's worth noting that the dataset may include variations of English, such as informal language, colloquialisms, and possibly slang, commonly found in online discussions.
 
-2. Generalization to the Entire Population: The dataset represents a subset of Reddit users who are active in discussions related to climate change, energy, and renewable energy. It may not be representative of the broader population's opinions or attitudes towards these topics, and caution should be exercised when generalizing findings.
-
-3. Bias and Limitations: Users should be aware of the potential biases and limitations associated with analyzing Reddit data, including selection bias, subreddit selection bias, user engagement bias, temporal bias, upvote bias, moderation bias, and social desirability bias. These factors may impact the interpretation of results and should be considered in analytical approaches.
+### Out-of-Scope Use
 
-4. Ethical Considerations: Researchers and analysts should adhere to ethical guidelines and respect Reddit's terms of service when using the dataset. Any research or analysis conducted using the dataset should prioritize user privacy, respect community guidelines, and avoid harmful or malicious actions.
+While the Reddit Climate Comment dataset offers valuable insights into discussions surrounding climate change, energy, and renewable energy topics on Reddit, there are certain out-of-scope uses to consider:
 
-It's essential for users of the dataset to exercise caution, critically evaluate the data and methodologies used, and consider the ethical implications of their analyses.
+1. The dataset should not be used for identifying or targeting individual Reddit users based on their comments.
+2. Researchers and analysts should adhere to ethical guidelines and respect Reddit's terms of service when using the dataset. Any research or analysis conducted using the dataset should prioritize user privacy, respect community guidelines, and avoid harmful or malicious actions.
 
 ## Dataset Structure