Skip to content

Commit

Permalink
Move all diags to dedicated workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
dfsnow committed Jun 7, 2024
1 parent 66d0c4b commit 5ebf1ca
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 218 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ jobs:
- name: Prepare Mermaid assets for docs
run: |
for file in inst/mermaid/*.mmd; do
mmdc -i "$file" -o "${file/.mmd/.pdf}"
mmdc -i "$file" -o "${file/.mmd/.svg}"
done
mkdir -p docs/mermaid
mv inst/mermaid/*.pdf docs/mermaid
mv inst/mermaid/*.svg docs/mermaid
working-directory: ${{ env.PROJECT_DIR }}
shell: bash

Expand Down
110 changes: 2 additions & 108 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -254,116 +254,10 @@ The PTAXSIM backend database contains cleaned data from the Cook County Clerk, T
### Database diagram

> :warning:
> [Click here](https://ccao-data.github.io/ptaxsim/mermaid/er-diagram-big.pdf)
> [Click here](https://ccao-data.github.io/ptaxsim/mermaid/er-diagram-big.svg)
> for a more detailed version of the diagram below.
```mermaid
erDiagram
agency {
int year PK
varchar agency_num PK
boolean home_rule_ind
bigint cty_cook_eav
double total_ext
}
agency_info {
varchar agency_num PK
varchar agency_name
varchar major_type
}
agency_fund {
int year PK
varchar agency_num PK
varchar fund_num PK
bigint final_levy
double final_rate
}
agency_fund_info {
varchar fund_num PK
varchar fund_name
boolean capped_ind
}
cpi {
int year
double cpi
double ptell_cook
int levy_year PK
}
eq_factor {
int year PK
double eq_factor_tentative
double eq_factor_final
}
metadata {
varchar db_version
varchar requires_pkg_version
int data_year_min
int data_year_max
}
pin {
int year PK
varchar pin PK
varchar class
}
pin_geometry {
int year
varchar pin10
text geometry
}
tax_code {
int year PK
varchar agency_num PK
double agency_rate
varchar tax_code_num PK
double tax_code_rate
}
tif {
int year PK
varchar agency_num PK
double prev_year_revenue
double curr_year_revenue
int first_year
boolean cancelled_this_year
}
tif_crosswalk {
int year
varchar agency_num_dist
varchar agency_num_final
}
tif_distribution {
int year PK
varchar agency_num PK
varchar tax_code_num PK
double tax_code_distribution_pct
}
eq_factor ||--|{ pin : "applies to"
pin ||--|{ tax_code : "within"
cpi ||--|{ agency : "applies to"
tax_code }|--|| agency : "has"
tax_code ||--o| tif_distribution : "may have"
agency ||--|{ agency_fund : "contains"
agency_info ||--|{ agency : "describes"
agency_fund_info ||--|{ agency_fund : "describes"
tif ||--|| tif_crosswalk : "in"
tif_distribution }|--|| tif_crosswalk : "in"
agency_info ||--o{ tif: "describes"
tax_code }|--o| tif : "may have"
pin_geometry ||--o| pin : "has"
```
![](https://ccao-data.github.io/ptaxsim/mermaid/er-diagram-small.svg)

## Notes and caveats

Expand Down
110 changes: 2 additions & 108 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -567,116 +567,10 @@ data was available in mid-2020.
### Database diagram

> :warning: [Click
> here](https://ccao-data.github.io/ptaxsim/mermaid/er-diagram-big.pdf)
> here](https://ccao-data.github.io/ptaxsim/mermaid/er-diagram-big.svg)
> for a more detailed version of the diagram below.
``` mermaid
erDiagram
agency {
int year PK
varchar agency_num PK
boolean home_rule_ind
bigint cty_cook_eav
double total_ext
}
agency_info {
varchar agency_num PK
varchar agency_name
varchar major_type
}
agency_fund {
int year PK
varchar agency_num PK
varchar fund_num PK
bigint final_levy
double final_rate
}
agency_fund_info {
varchar fund_num PK
varchar fund_name
boolean capped_ind
}
cpi {
int year
double cpi
double ptell_cook
int levy_year PK
}
eq_factor {
int year PK
double eq_factor_tentative
double eq_factor_final
}
metadata {
varchar db_version
varchar requires_pkg_version
int data_year_min
int data_year_max
}
pin {
int year PK
varchar pin PK
varchar class
}
pin_geometry {
int year
varchar pin10
text geometry
}
tax_code {
int year PK
varchar agency_num PK
double agency_rate
varchar tax_code_num PK
double tax_code_rate
}
tif {
int year PK
varchar agency_num PK
double prev_year_revenue
double curr_year_revenue
int first_year
boolean cancelled_this_year
}
tif_crosswalk {
int year
varchar agency_num_dist
varchar agency_num_final
}
tif_distribution {
int year PK
varchar agency_num PK
varchar tax_code_num PK
double tax_code_distribution_pct
}
eq_factor ||--|{ pin : "applies to"
pin ||--|{ tax_code : "within"
cpi ||--|{ agency : "applies to"
tax_code }|--|| agency : "has"
tax_code ||--o| tif_distribution : "may have"
agency ||--|{ agency_fund : "contains"
agency_info ||--|{ agency : "describes"
agency_fund_info ||--|{ agency_fund : "describes"
tif ||--|| tif_crosswalk : "in"
tif_distribution }|--|| tif_crosswalk : "in"
agency_info ||--o{ tif: "describes"
tax_code }|--o| tif : "may have"
pin_geometry ||--o| pin : "has"
```
![](https://ccao-data.github.io/ptaxsim/mermaid/er-diagram-small.svg)

## Notes and caveats

Expand Down

0 comments on commit 5ebf1ca

Please sign in to comment.