Skip to content

Update README.md to reflect 2024 changes#86

Merged
kyrasturgill merged 16 commits into2024-data-updatefrom
kyrasturgill/2024-readme-update
Apr 28, 2026
Merged

Update README.md to reflect 2024 changes#86
kyrasturgill merged 16 commits into2024-data-updatefrom
kyrasturgill/2024-readme-update

Conversation

@kyrasturgill
Copy link
Copy Markdown
Member

Necessary README updates to reflect the 2024 update. Not a ton to be changed here as I thought there would be. I opted to keep most things the same, barring where an update was required. Most substantial change is to the database diagrams, which I hope will render correctly!

@kyrasturgill kyrasturgill changed the title Update README.md Update README.md to reflect 2024 changes Apr 22, 2026
Comment thread README.Rmd
name = "Total Tax Amount",
labels = scales::dollar,
expand = c(0, 0),
expand = expansion(mult = c(0, .05)),
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the dramatic 2024 increase I thought the axis spacing was making it look as though it was cut off, so I added some more buffer here.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Question, non-blocking] It's a bit hard to tell since the Y-axes are not aligned, but it looks as if the increment value is now larger between 2016 and 2023 than it was in the previous version of the chart, even setting aside the big jump in 2024 (which is also pretty shocking, so much so that we should fact check it). Do you see that too? If so, any idea why might be the case?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see that too when looking at the diff - this .png was generated when I knitted the file but when I am running that code chunk alone it appears correct and aligned with the old viz. Weird, not sure why that is happening!
Here is image I get when I just ran it:
image

And as for the dramatic spike, this PIN's AV spiked in 2024, going from 7000 to 12500. Perhaps we should select a PIN with more stable AV?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this .png was generated when I knitted the file but when I am running that code chunk alone it appears correct and aligned with the old viz. Weird, not sure why that is happening!

That's so strange! Let me know if you want a second eye debugging it. I get the correct and more aligned version when I run it and knit it locally too, although I have to tweak the two DBI::dbConnect() paths to point to the correct database -- I wonder if it's possible that you have two different versions of the database, one of which gets loaded instead of the other when knitting vs. running locally? Very low confidence in that diagnosis, it's just an idea as to the kind of thing that might be going wrong. In any case, I think we should make sure we have the correct / aligned version of the chart before we merge.

And as for the dramatic spike, this PIN's AV spiked in 2024, going from 7000 to 12500. Perhaps we should select a PIN with more stable AV?

Got it, that makes sense! I don't mind keeping it as is, it's kind of interesting to see such a dramatic spike in 2024.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I have addressed the problem. When knitting the doc it was loading the existing version of the ptaxsim package rather than the dev version which meant TIF amounts were not being calculated correctly. I knit the doc with it loading the dev version and pushed the updated viz .png and .md files but I'm not 100% sure that was the right way to do it

Comment thread README.Rmd
Copy link
Copy Markdown
Member

@jeancochrane jeancochrane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work here! I'm glad this is so simple. There's only one issue with the small diagram that I think is blocking; otherwise, consider everything else below to be suggestions.

Comment thread inst/mermaid/er-diagram-big.mmd Outdated
Comment thread README.Rmd
name = "Total Tax Amount",
labels = scales::dollar,
expand = c(0, 0),
expand = expansion(mult = c(0, .05)),
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Question, non-blocking] It's a bit hard to tell since the Y-axes are not aligned, but it looks as if the increment value is now larger between 2016 and 2023 than it was in the previous version of the chart, even setting aside the big jump in 2024 (which is also pretty shocking, so much so that we should fact check it). Do you see that too? If so, any idea why might be the case?

Comment thread README.Rmd
Comment thread inst/mermaid/er-diagram-big.mmd
Comment thread inst/mermaid/er-diagram-small.mmd
Comment thread inst/mermaid/er-diagram-small.mmd Outdated
Comment on lines +99 to +101
double transit_tif_to_cps
double transit_tif_to_tif
double transit_tif_to_dist
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Nitpick, optional] I wonder if these transit_tif_to_* fields are even worth including in this small version of the diagram? They're definitely important, but I also think we could cut them for further simplicity.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was debating this as well, I am fine with removing

Comment thread inst/mermaid/er-diagram-small.mmd
@kyrasturgill
Copy link
Copy Markdown
Member Author

@jeancochrane I believe I implemented all requested edits - only thing I'm unclear on is why the viz is off when the doc is rendered.

Copy link
Copy Markdown
Member

@jeancochrane jeancochrane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, barring one small change to the fund_type_num definition in create_db.sql that I can't quite explain! Let's plan to pair on Tuesday to see if we can figure out why the knitted chart looks different from the one that renders locally. Once we get that resolved, this is good to merge.

Comment thread data-raw/create_db.sql Outdated
CREATE TABLE agency_fund_info (
agency_num varchar(9) NOT NULL,
fund_type_num varchar(3) NOT NULL,
fund_type_num varchar(6) NOT NULL,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Question, non-blocking] Was this change intentional?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm losing it, I must have ready this as fund_num and thought I'd made a mistake. I will revert this change.

Copy link
Copy Markdown
Member

@jeancochrane jeancochrane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for getting to the bottom of the chart rendering issue!

Comment thread data-raw/create_db.sql
fund_name varchar NOT NULL,
capped_ind boolean NOT NULL,
PRIMARY KEY (agency_num, fund_type_num, fund_num)
PRIMARY KEY (agency_num, fund_num)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Question, non-blocking] Just to clarify: I believe we will need to do a new database export to reflect this change, correct? It's not a big deal -- the most important advantages of primary keys are uniqueness constraints and indexes, neither of which is particularly important for this use-case -- but I just want to make sure my understanding is correct.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep that's correct! Which we will ultimately need to do now anyway to incorporate the new agency crosswalks.

@kyrasturgill kyrasturgill merged commit 0d23764 into 2024-data-update Apr 28, 2026
7 checks passed
@kyrasturgill kyrasturgill deleted the kyrasturgill/2024-readme-update branch April 28, 2026 20:32
@jeancochrane jeancochrane linked an issue Apr 29, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make sure README is up to date with 2024 changes

2 participants