Update README.md

README.md

@@ -8,12 +8,14 @@ tags:
 pretty_name: Regulation.gov Public Comments API
 size_categories:
 - n<1K
+task_categories:
+- text-classification
 ---
 # Dataset Card for Regulatory Comments (Direct API Call)
 
 United States governmental agencies often make proposed regulations open to the public for comment. 
 Proposed regulations are organized into "dockets". This dataset will use Regulation.gov public API 
-to aggregate and clean public comments for dockets that mention opioid use. 
+to aggregate and clean public comments for dockets selected by the user
 
 Each example will consist of one docket, and include metadata such as docket id, docket title, etc. 
 Each docket entry will also include information about the top 10 comments, including comment metadata
@@ -27,8 +29,10 @@ reference https://huggingface.co/datasets/ro-h/regulatory_comments.
 
 ### Dataset Description and Structure
 
-This dataset will call the API to individually gather docket and comment information; data collection will stop when 
-all dockets with opioid-related information have been gathered, or when the API hits a rate-limit. The government 
+This dataset will call the API to individually gather docket and comment information. The user must input their 
+own API key ([https://open.gsa.gov/api/regulationsgov/]), as well as a list of dockets they want to draw information from.
+
+Data collection will stop when all dockets input have been gathered, or when the API hits a rate-limit. The government 
 API limit is 1000 calls per hour. Since each comment's text requires an individual call and there will be ~10 comments collected per docket, 
 only around 100 dockets can be collected without extending the limit. Furthermore, since some dockets don't have comment data and 
 thus will not be included, it is realistic to expect approximatley 60-70 dockets collected. For this number of dockets, expect a load 
@@ -70,6 +74,14 @@ comment_length (int): The length of the comment in terms of the number of charac
 **Comment Content**
 text (str): The actual text of the comment submitted. This is the primary content for analysis, containing the commenter's views, arguments, and feedback on the regulatory matter. 
 
+
+
+Note that commenter name features were phased in later in the system, so some dockets will have no 
+first name/last name entries. Further, some comments were uploaded solely via attachment,
+and are stored in the system as null; the API has no access to comment attachments. 
+Finally, note that huggingface converts lists of dictionaries to dictionaries of lists.
+
+
 - **Curated by:** Ro Huang
 
 ### Dataset Sources
@@ -107,8 +119,7 @@ accordingly.
 
 While this is a vital part of the United States regulatory process, there is little understanding of how agencies approach
 public comments and modify their proposed regulations. Further, the data extracted from the API is often unclean and difficult
-to navigate. This dataset seeks to offer some clarity through aggregating comments related to Opioid Use Disorders, 
-an issue that a diversity of stakeholders have investment in. 
+to navigate.
 
 #### Data Collection and Processing