Create README.md

README.md

@@ -0,0 +1,145 @@
+---
+annotations_creators:
+- lexyr
+language_creators:
+- crowdsourced
+languages:
+- en
+licenses:
+- cc-by-4.0
+multilinguality:
+- monolingual
+size_categories:
+- 1M<n<10M
+source_datasets:
+- original
+paperswithcode_id: null
+---
+
+# Dataset Card for the-reddit-covid-dataset
+
+## Table of Contents
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+  - [Contributions](#contributions)
+  
+  
+## Disclaimer
+Due to file size limitations, we are not able to provide the comments for this dataset. Please feel free to download them from the [website](https://socialgrep.com/datasets?utm_source=huggingface&utm_medium=link&utm_campaign=theredditcoviddataset#the-reddit-covid-dataset) - no registration required.
+
+## Dataset Description
+
+- **Homepage:** [https://socialgrep.com/datasets](https://socialgrep.com/datasets?utm_source=huggingface&utm_medium=link&utm_campaign=theredditcoviddataset)
+- **Point of Contact:** [Website](https://socialgrep.com/contact?utm_source=huggingface&utm_medium=link&utm_campaign=theredditcoviddataset)
+
+### Dataset Summary
+
+This corpus contains all the mentions of the term `covid` in post titles on the social media platform Reddit, up until the 25th of October, 2021.
+
+The data was procured from Reddit using [SocialGrep](https://socialgrep.com/?utm_source=huggingface&utm_medium=link&utm_campaign=theredditcoviddataset).
+
+### Languages
+
+Mainly English.
+
+## Dataset Structure
+
+### Data Instances
+
+A data point is a post or a comment. Due to the separate nature of the two, those exist in two different files - even though many fields are shared.
+
+### Data Fields
+
+- 'type': the type of the data point. Can be 'post' or 'comment'.
+- 'id': the base-36 Reddit ID of the data point. Unique when combined with type.
+- 'subreddit.id': the base-36 Reddit ID of the data point's host subreddit. Unique.
+- 'subreddit.name': the human-readable name of the data point's host subreddit.
+- 'subreddit.nsfw': a boolean marking the data point's host subreddit as NSFW or not.
+- 'created_utc': a UTC timestamp for the data point.
+- 'permalink': a reference link to the data point on Reddit.
+- 'score': score of the data point on Reddit.
+
+- 'domain': (Post only) the domain of the data point's link.
+- 'url': (Post only) the destination of the data point's link, if any.
+- 'selftext': (Post only) the self-text of the data point, if any.
+- 'title': (Post only) the title of the post data point.
+
+- 'body': (Comment only) the body of the comment data point.
+- 'sentiment': (Comment only) the result of an in-house sentiment analysis pipeline. Used for exploratory analysis.
+
+## Dataset Creation
+
+### Curation Rationale
+
+[Needs More Information]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[Needs More Information]
+
+#### Who are the source language producers?
+
+[Needs More Information]
+
+### Annotations
+
+#### Annotation process
+
+[Needs More Information]
+
+#### Who are the annotators?
+
+[Needs More Information]
+
+### Personal and Sensitive Information
+
+[Needs More Information]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[Needs More Information]
+
+### Discussion of Biases
+
+[Needs More Information]
+
+### Other Known Limitations
+
+[Needs More Information]
+
+## Additional Information
+
+### Dataset Curators
+
+[Needs More Information]
+
+### Licensing Information
+
+CC-BY v4.0
+
+### Contributions
+
+[Needs More Information]