ro-h commited on
Commit
9665a58
1 Parent(s): 03fdbe6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +7 -6
README.md CHANGED
@@ -16,12 +16,14 @@ reference https://huggingface.co/datasets/ro-h/regulatory_comments.
16
 
17
  ### Dataset Description and Structure
18
 
19
- This dataset will contain approximately 70 dockets. The number of dockets included are rate-limited by the
20
- government API. If a larger set of dockets are required, consider requesting a rate-unlimited API key and
21
- directly calling from the API using [https://huggingface.co/datasets/ro-h/regulatory_comments_api].
 
 
22
 
23
- Each docket will be associated with at least one comment. The maximum number of comments per docket is 10.
24
- Comments will be retrieved in relevance order according to Regulation.gov.
25
 
26
  The following information is included in this dataset:
27
 
@@ -84,7 +86,6 @@ public comments and modify their proposed regulations. Further, the data extract
84
  to navigate. This dataset seeks to offer some clarity through aggregating comments related to Opioid Use Disorders,
85
  an issue that a diversity of stakeholders have investment in.
86
 
87
-
88
  #### Data Collection and Processing
89
 
90
  **Filtering Methods:**
 
16
 
17
  ### Dataset Description and Structure
18
 
19
+ This dataset will call the API to individually gather docket and comment information; data collection will stop when
20
+ all dockets with opioid-related information have been gathered, or when the API hits a rate-limit. The government
21
+ 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,
22
+ only around 100 dockets can be collected without extending the limit. Furthermore, since some dockets don't have comment data and
23
+ thus will not be included, it is realistic to expect approximatley 60-70 dockets collected.
24
 
25
+ If a larger set of dockets are required, consider requesting a rate-unlimited API key. For more details, visit
26
+ [https://open.gsa.gov/api/regulationsgov/].
27
 
28
  The following information is included in this dataset:
29
 
 
86
  to navigate. This dataset seeks to offer some clarity through aggregating comments related to Opioid Use Disorders,
87
  an issue that a diversity of stakeholders have investment in.
88
 
 
89
  #### Data Collection and Processing
90
 
91
  **Filtering Methods:**