policy-rules-database
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.5%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: Research-Division
- License: gpl-3.0
- Language: R
- Default Branch: main
- Size: 325 MB
Statistics
- Stars: 9
- Watchers: 4
- Forks: 6
- Open Issues: 24
- Releases: 4
Metadata Files
README.md
Policy Rules Database (PRD)
The Policy Rules Database (PRD) is an open-source repository that contains up-to-date rules and provisions for all major federal and state public assistance programs, taxes, and tax credits in a single easy-to-use database.
Subscribe to receive email updates about new features of the Policy Rules Database
To learn more, visit the PRD website
Read PRD Technical Manual to get started with the PRD and to learn details about each program included in the database
Analyze the structure of the U.S. social safety net using PRD Dashboard
The terms of the PRD use are defined by the GNU General Public License v3.0. If you are interested in alternative licensing arrangements, please contact cliff@atl.frb.org
Citing the Policy Rules Database
The Policy Rules Database (PRD) was originally developed by Elias Ilin and Ellyn Terry at the Federal Reserve Bank of Atlanta. The proper citation for the PRD can be found by clicking "Cite this repository" on the Github PRD repo page.
How to Use This Repository?
Step 1: Download the repository
Download and unzip this repository to your local machine. Make sure you have R and RStudio installed.
Step 2: Specify settings of the simulation - family characteristics and public benefits
Open TEST.yml file located in the projects folder. Adjust each input accordingly.
Step 3: Run the simulation
Open applyBenefitsCalculator.R and run the program.
Step 4: Explore the results
Results of the simulation are saved as a csv file in the output folder.
Step 5 (Optional): Modify and Explore
The PRD GitHub repository gives users flexibility in how to use the database. That includes:
Modifying benefits_functions.R located in functions folder to produce policy simulations
Applying PRD calculations to external datasets (CPS, ACS, SIPP etc) for microsimulation purposes
Description of Each File Included in This Repository
This folder contains the following files:
1. "PRD Technical Manual.pdf"
This document provides detailed information on each public assistance program and tax credit included in the PRD. The document also describes the programming steps necessary to implement the calculations for each program in any programming language.
2. "prd_parameters" folder
Contains main Policy Rules Database parameters files in RData format. These files are then used by the PRD functions to produce the calculations
The following files are located in this folder:
- benefit.parameters.RData - eligibility & benefits parameters for each public assistance programs and tax credit included into the PRD
- expenses.RData - parameters from the supplementary cost-of-living database that can be used to retrieve information required to implement PRD calculations
- parameters.defaults.RData - default parameters used elsewhere in the PRD calculations (such as number of school days, number of summer days etc)
- tables.RData - supplemental tables and crosswalks (e.g. SMIs, FPLs, state FIPS to state name mapping etc)
3. "functions" folder
Contains main Policy Rules Database functions written in R programming language. These functions read-in parameters from (1) and determine eligibility/calculate the dollar value of benefits for each program.
The following files are located in this folder:
- benefits_functions.R - functions that read-in PRD parameters and determine eligibility/calculate value of benefits for each public assistance program and tax credit contained in the PRD
- expense_functions.R - functions that assign default expenses using Cost of Living Database
- BenefitsCalculator_functions.R - higher-level program that aggregates smaller functions into blocks (Expenses, Childcare, Healthcare, Food and Housing, Taxes and Tax Credits, Other Benefits)
4. applyBenefitsCalculator.R
High-level program that runs the Benfits Calculator in its entirety
5. libraries.R
Packages and libraries required to run example codes below
6. "projects" folder
YML files that are used to provide the specification for the PRD (i.e. specify the family demographics and benefits composition to run through the PRD). TEST.yml is then read-in by the applyBenefitsCalculator.R program and produces calculations
To test changes/run PRD you can do the following:
- In projects folder, copy TEST.yml to YOUR_NAME.yml
- Open YOUR_NAME.yml file in any text editor; adust specifications as needed
- Open applyBenefitsCalculator.R; specify PROJECT object as YOUR_NAME
- Run the program. Results are saved to the "output" folder as resultsYOURNAME.csv file
7. "output" folder
applyBenefitsCalculator.R program saves the resulted output into this folder
8. PRD Dashboard
The Policy Rules Database (PRD) Dashboard is a user-friendly visualization tool designed to provide comprehensive insights into how various public assistance programs and tax credits intersect to support families across different locations in the United States.
Owner
- Name: Research Division - Federal Reserve Bank of Atlanta
- Login: Research-Division
- Kind: organization
- Location: United States of America
- Repositories: 1
- Profile: https://github.com/Research-Division
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Federal Reserve Bank of Atlanta" given-names: "" title: "Policy Rules Database" version: x.x.x url: "https://github.com/Research-Division/policy-rules-database"
GitHub Events
Total
- Issues event: 19
- Watch event: 5
- Delete event: 18
- Issue comment event: 2
- Member event: 2
- Push event: 65
- Pull request event: 17
- Fork event: 3
- Create event: 20
Last Year
- Issues event: 19
- Watch event: 5
- Delete event: 18
- Issue comment event: 2
- Member event: 2
- Push event: 65
- Pull request event: 17
- Fork event: 3
- Create event: 20
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 11
- Total pull requests: 6
- Average time to close issues: 3 months
- Average time to close pull requests: 2 minutes
- Total issue authors: 4
- Total pull request authors: 2
- Average comments per issue: 0.18
- Average comments per pull request: 0.0
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 9
- Pull requests: 6
- Average time to close issues: 28 days
- Average time to close pull requests: 2 minutes
- Issue authors: 3
- Pull request authors: 2
- Average comments per issue: 0.22
- Average comments per pull request: 0.0
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- EdgarRys (20)
- jtwalker-frba (7)
- aruder (5)
- dtasconbuchelly (1)
- paulmohnen (1)
- ellieterry (1)
Pull Request Authors
- jtwalker-frba (11)
- aruder (3)
- EdgarRys (2)
- schpet (1)
- alvarocsanchez (1)
- dtasconbuchelly (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v3 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite