Skip to content

Commit

Permalink
Revise targets file documentation in areas/targets/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
martinholmer committed Oct 24, 2024
1 parent e83496e commit 7a24355
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions tmd/areas/targets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
Contains sub-national area targets files.


Targets File Content
====================
# Targets File Content

An areas targets file is a CSV-formatted file with its first row
containing column names and its second row containing the area
Expand All @@ -26,16 +25,16 @@ Here are the column names and their valid values:
scope==1 implies PUF-derived filing units, and
scope==2 implies CPS-derived filing units.

- **`agilo`**: float representing lower bound of an AGI range,
which is included in the range.
- **`agilo`**: float representing lower bound of an AGI range (which
is included in the range) that is tabulated.

- **`agihi`**: float representing upper bound of an AGI range,
which is excluded from the range.
- **`agihi`**: float representing upper bound of an AGI range (which
is excluded from the range) that is tabulated.

- **`fstatus`**: integer in [0,5] range: fstatus=0 implies all
tax units, other fstatus values imply just the
tax units with the Tax-Calculator `MARS` variable
equal to fstatus.
- **`fstatus`**: integer in [0,5] range: fstatus=0 implies all tax
units are tabulated, other fstatus values imply just
the tax units with the Tax-Calculator `MARS` variable
equal to fstatus are included in the tabulation.

- **`target`**: target amount (dollars if count==0 or number of
tax units if count==1 or count==2).

0 comments on commit 7a24355

Please sign in to comment.