This repo stores the code necessary to generate experimental reports explaining how the CCAO Data team's residential model valued any particular single-family home or multifamily home with six or fewer units.
Warning
This project is an experimental work-in-progress and is not yet used in production. Reports generated using this code may not accurately reflect model behavior or CCAO policy.
We currently support two ways of generating PINVAL reports: With Quarto or with Hugo.
This project expects that you have R and the Quarto CLI installed on your machine. A working installation of RStudio is recommended, but not required.
- Ensure that renv is installed:
install.packages("renv")- Create a renv environment and install R dependencies:
renv::restore()-
[Optional] If you would like to run the report for a specific PIN, year, or model run, adjust run parameters under the
paramsattribute in the YAML front matter inpinval.qmd. -
Make sure you are authenticated with AWS.
-
Render the
pinval.qmdreport using Quarto, either by clicking the "Render" button in the RStudio UI or by calling the Quarto CLI:
quarto render pinval.qmd --to html -o pinval.html
This project expects that you have the Hugo CLI installed on your machine.
Note
While the Data team often does work on the server, you should do Hugo
development on your laptop in order to run the development site. Hugo
installation is easiest using WSL, where you can install it by running
sudo snap install hugo and entering your WSL user password. Your WSL
password will most likely be different from your laptop password; if
you're having trouble authenticating, reach out to a senior staff member
for help.
- Ensure that Hugo is installed correctly by running
hugo version. - Navigate to the
hugo/subdirectory and run the development server:
cd hugo
hugo serve
- For a quick sample report, see the examples: