Update README.md

README.md

@@ -1,3 +1,143 @@
 ---
 license: mit
+language:
+- en
+tags:
+- climate
+- energy
+- climatechange
+- reddit
+- socialnetwork
+- comment
+size_categories:
+- 10K<n<100K
 ---
+# Dataset Card for Reddit Climate Comment
+
+## 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.
+
+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.
+
+- **Curated by:** Reddit users and the Reddit platform
+- **Language(s):** English
+- **License:** MIT
+
+### Dataset Sources
+
+- **Repository:** [More Information Needed]
+- **API Documentation:** [https://www.reddit.com/dev/api/]
+
+## Uses
+
+<!-- Address questions around how the dataset is intended to be used. -->
+
+### Direct Use
+
+<!-- This section describes suitable use cases for the dataset. -->
+
+[More Information Needed]
+
+### 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:
+
+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.
+
+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.
+
+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.
+
+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.
+
+## Dataset Structure
+
+<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+
+[More Information Needed]
+
+## Dataset Creation
+
+### Curation Rationale
+
+The inclusion of the term "energy" in addition to subreddits focused on environment sustainability allows for a more comprehensive representation of discussions. While the primary focus revolves around clean energy topics, the inclusion of a broader spectrum such as "energy" captures a diverse array of discussions related to the energy sector at large, and facilitates a nuanced understanding of how conversations around clean energy compare and potentially contrast with discussions on energy more broadly. By encompassing both clean energy and general energy discussions, the dataset enables researchers and analysts to discern trends, sentiments, and engagement levels in each domain. This comparative approach enhances the dataset's utility, providing a holistic view of the Reddit community's dialogue on energy-related topics. The dataset's inclusion of the subreddit "climate" and “climatechange” introduces another layer of comparison. While "energy" and "renewable energy" provide detailed insights into people's opinions, "climate" and “climatechange” serves as a reflection of the community's overall perspectives and attitudes toward the topic in general. This multi-perspective approach enriches the dataset, enabling a more thorough examination of the diverse facets and opinions within the Reddit community's discourse on energy and climate change related subjects.
+
+[More Information Needed]
+
+### Source Data
+
+The source data for this dataset comprises comments contributed by Reddit users participating in discussions on climate change, energy, and renewable energy topics within designated subreddits. These subreddits include "Climate," "Energy," "RenewableEnergy", and “ClimateChange”. The comments were extracted from the top posts within these subreddits using the Reddit API.
+
+#### Data Collection and Processing
+
+The data collection process involved extracting comments from the top posts in selected subreddits, including "Climate," "Energy," "RenewableEnergy", and “ClimateChange”, using the Reddit API. The PRAW Python library was utilized for interacting with the Reddit API. Specifically, the top ~1000 posts were considered in each subreddit, with approximately 20 comments collected under each post. The data collection was performed on January 31st, 2024.
+
+The processing steps included:
+
+1. Text Cleaning: Removal of unnecessary characters, HTML tags, or formatting artifacts, and conversion of text to lowercase for consistency.
+2. Parsing Timestamps: Conversion of timestamps to a standardized date-time format.
+3. Duplicate Removal: Checking for and removing duplicate comments to ensure dataset integrity.
+4. Updated Data Organization
+     To enhance the structure and organization of the dataset, under the same subreddit community, we group comments under the same post title, identified by a unique post ID. Each post ID serves as an identification number, and all relevant information, including author, comment bodies, timestamps, and upvotes, is grouped together within this array-like structure.
+
+**Benefits of the New Structure**
+1. Each post is uniquely identified by an assigned post ID, facilitating easy referencing and retrieval of information for specific posts.
+2. Structured Comment Grouping provides a coherent and organized representation of discussions under each post and each subreddit community.
+3. The array-based structure enhances the dataset's readability and accessibility, streamlining the process of extracting and analyzing information for each post.
+4. The standardized format ensures a consistent approach to retrieving relevant data elements, such as authors, comment bodies, timestamps, and upvotes, for analysis or visualization.
+
+These steps aimed to prepare the data for analysis while maintaining and improving its quality and consistency.
+
+#### Who are the source data producers?
+
+The source data producers are Reddit users who contributed comments to discussions on climate change, energy, and renewable energy topics within the specified subreddits.
+
+#### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Bias, Risks, and Limitations
+
+When dealing with discussions related to climate, energy, and renewable energy on the Reddit platform, it's essential to consider potential biases that may influence the data and subsequent analyses.
+1. **Selection Bias**: the demographic composition of Reddit users may not be representative of the general population. Certain age groups, geographic regions, or ideological perspectives might be overrepresented or underrepresented, influencing the nature of discussions.
+2. **Subreddit Selection Bias**: the choice of subreddits (e.g., "climate," "energy," "renewableenergy", and “climatechange”) introduces bias towards specific topics. This may lead to a skewed representation, as discussions in these subreddits may not reflect the broader spectrum of opinions on climate and energy.
+3. **User Engagement Bias**: the dataset may primarily capture comments from active participants, potentially overlooking the opinions of more passive or silent observers. This could result in a biased representation of sentiments and perspectives.
+4. **Temporal Bias**: the dataset's timeframe might be influenced by specific events, leading to a temporal bias. For instance, discussions during a major climate event may differ significantly from those during less eventful periods.
+5. **Upvote Bias**: highly upvoted comments may receive more visibility, potentially shaping the perceived popularity of certain opinions. This could result in a bias towards more commonly accepted viewpoints.
+6. **Moderation Bias**: different subreddits may have varying moderation policies, influencing the types of discussions allowed. Biases may arise if certain perspectives are disproportionately favored or discouraged by moderators.
+7. **Social Desirability Bias**: users may conform to the prevailing opinions within a subreddit to avoid conflict or gain social approval. This social desirability bias may impact the authenticity of expressed opinions.
+
+In addition to biases, there are several other known limitations associated with working with datasets focused on climate, energy, and renewable energy discussions on Reddit. Being aware of these limitations is crucial for researchers and analysts to interpret results accurately and responsibly:
+1. **Anonymity and Reliability**: Reddit users typically operate under pseudonyms, making it challenging to verify the credibility and reliability of information shared. The lack of real-world identity verification introduces a potential limitation in assessing the authenticity of comments.
+2. **Quality of Comments**: the quality of comments can vary widely, ranging from well-informed opinions to low-quality or irrelevant contributions. The dataset may include noise and off-topic discussions, affecting the overall quality of insights derived.
+3. **Limited Context**: Reddit comments often lack the depth of context found in longer-form content. This limitation may make it challenging to fully understand the nuances of certain discussions or to interpret the sentiment accurately.
+4. **Reddit Algorithm Impact**: the visibility and accessibility of comments are influenced by Reddit's algorithms. Changes in these algorithms may affect the reach and engagement of certain discussions, introducing a dynamic aspect that researchers should be mindful of.
+
+### Recommendations
+
+Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
+
+## Citation [optional]
+
+<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+
+**BibTeX:**
+
+[More Information Needed]
+
+**APA:**
+
+[More Information Needed]
+
+## Contribution
+
+We express gratitude to the Reddit community for their contributions to climate change and energy discussions. Special thanks to the PRAW library for enabling efficient Reddit API interactions, making this dataset possible.
+
+## Dataset Card Contact
+
+[More Information Needed]