Skip to content

zhoudanxie/analyzing-public-comments

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Background

Under a cooperative agreement with the U.S. Department of Agriculture (USDA), the George Washington University Regulatory Studies Center conducted research analyzing public comments to inform agency regulatory reform efforts in the United States. A group of faculty members and researchers affiliated with the GW Regulatory Studies Center contributed to the research project, and subject matter experts at the USDA Office of the Chief Economist provided technical advice. The research report is available at: https://regulatorystudies.columbian.gwu.edu/putting-food-table-agriculture-and-regulation.

In this research, we (the GW Regulatory Studies Center research team) developed Python code to retrieve, clean, and analyze data of public comments. We share the code in this repository. The goal is to provide code that can be easily modified for use in other research using public comments.

We will update this repository routinely with new code from the above project and future research using comments. The initial content available in the repository includes the code to retrieve public submissions via the Regulations.gov API, including comments submitted as PDF attachments, and convert them into text data. As we continue uploading new content, we hope other researchers and programmers can contribute to the repository or suggest improvements to make it a more useful tool.

For beginners who use Python for the first time, you may find resources in the For Python Beginners folder useful.

Retrieve public comments from Regulations.gov

Regulations.gov API

Regulations.gov is a central portal for public users to access U.S. federal regulatory materials and submit comments on proposed regulations. It was launched by the eRulemaking Program in January 2003. Today, nearly 300 federal agencies post an average of 8,000 regulations per year, among which the majority receive comments and share them on Regulations.gov, while others accept and post comments via other online platforms.

Regulations.gov offers all its public data in machine readable format via an API (Application Programming Interface), which allows users to search and retrieve data on public submissions and other regulatory materials in an automated way. All the content that can be obtained using the regular search function on Regulations.gov is available in json or xml format if an equivalent API query is used. This includes the full text of comments and rules, as well as their metadata such as agency name, commenter name, publication date, etc.

For a detailed description of Regulations.gov API, visit: https://regulationsgov.github.io/developers/.

How to request a API key

The first thing you need to use the Regulations.gov API is a unique API key designated to you or your organization. You can contact the Regulations.gov Help Desk to request an API key, providing the information listed on this page.

You will then receive instructions and a URL for signing up an API key. You will be assigned a API key immediately, but it is not ready for use immediately. You will need to send the key back to the Regulations.gov Help Desk for the developers to activate your key for use on Regulations.gov. The activation process may take a few days to a couple of weeks.

Get comments submitted to a docket using API

If you would like to retrieve the full text of comments submitted to a Regulations.gov docket (e.g., Identifying Regulatory Reform Initiatives), follow these steps:

  • Export the docket folder: the exported file contains metadata for all the documents in the docket (e.g., rules, public submissions), including a Document ID for each comment which will be used as an identifier in API quiries.
    • Go to the Docket Folder Summary page (example).
    • Click on View All in the Comments section.
    • Click on Export (on top of the results) and save the .csv file to your local folder.
  • Modify and run the Python script "Retrieve Comments/GetComments.py" to download comments submitted to the docket in both text and attachment format.
    • Modify the script following the annotations in the script, including adding your API key and specifying the location of your exported docket metadata file, etc.
    • Run the script to export all text comments into a .csv file (or any other desired format) and download all comments submitted as PDF or DOC attachments to your designated folder. In very rare cases, comments are submitted in other formats, such as .jpg or .xml files. In those cases, the script will direct you to download those comments manually.

Notes: Regulations.gov sets a rate limit of 1,000 requests per hour applied to all API users. A pause is added between two requests using time.sleep() in the script to avoid errors. As a result, it may take a long time if you are retrieving a large number of comments.

Convert PDF/DOC comments into text

Comments can be submitted as either plain text or attachments (PDF, DOC, etc.) on Regulations.gov. If you have run through the GetComments script, all text comments are now exported into a .csv file, and all comments submitted as attachments are downloaded into your designated folder. There are many options available online to convert PDF or DOC files into text. Here we share the Python code we used to convert all PDF and DOC files in a folder at one time. To execute the code:

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages