Add a data dictionary and remove duplicate features from it #86
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jeancochrane
changed the title
jeancochrane
commented
Jan 14, 2025
| @@ -60,13 +60,14 @@ We leverage these qualities to produce what we call ***strata***, a feature uniq | |||
|
|
|||
| ### Features Used | |||
|
|
|||
| Because our individual condo unit characteristics are sparse and incomplete, we primarily must rely on aggregate geospatial features, economic features, [strata](#condo-strata), and time of sale to determine condo assessed values. The features in the table below are the ones used in the 2024 assessment model. | |||
| Because our individual condo unit characteristics are sparse and incomplete, we primarily must rely on aggregate geospatial features, economic features, [strata](#condo-strata), and time of sale to determine condo assessed values. The features in the table below are the ones used in the most recent assessment model. | |||
There was a problem hiding this comment.
Is "most recent" OK here, or would you rather we continue to update this manually?
There was a problem hiding this comment.
"Most recent" is definitely fine.
Comment on lines
+208
to
+212
| We maintain a few useful resources for working with these features: | ||
|
|
||
| - Once you've [pulled the input data](#getting-data), you can inner join the data to the CSV version of the data dictionary ([`docs/data-dict.csv`](./docs/data-dict.csv)) to filter for only the features that we use in the model. | ||
| - You can browse our [data catalog](https://ccao-data.github.io/data-architecture/#!/overview) to see more details about these features, in particular the [condo model input view](https://ccao-data.github.io/data-architecture/#!/model/model.ccao_data_athena.model.vw_pin_condo_input) which is the source of our training data. | ||
| - You can use the [`ccao` R package](https://ccao-data.github.io/ccao/) or its [Python equivalent](https://ccao-data.github.io/ccao/python/) to programmatically convert variable names to their human-readable versions ([`ccao::vars_rename()`](https://ccao-data.github.io/ccao/reference/vars_rename.html)) or convert numerically-encoded variables to human-readable values ([`ccao::vars_recode()`](https://ccao-data.github.io/ccao/reference/vars_recode.html). The [`ccao::vars_dict` object](https://ccao-data.github.io/ccao/reference/vars_dict.html) is also useful for inspecting the raw crosswalk that powers the rename and recode functions. |
There was a problem hiding this comment.
This paragraph is tweaked from the res model, but I'm wondering if perhaps it's too much duplicate information. Let me know if you think there's a slimmer way of pointing users to these resources without fully duplicating this section between the res and condo models.
There was a problem hiding this comment.
I think this is totally fine for now. We can consolidate later when we do a rewrite.
dfsnow
approved these changes
Jan 16, 2025
| @@ -60,13 +60,14 @@ We leverage these qualities to produce what we call ***strata***, a feature uniq | |||
|
|
|||
| ### Features Used | |||
|
|
|||
| Because our individual condo unit characteristics are sparse and incomplete, we primarily must rely on aggregate geospatial features, economic features, [strata](#condo-strata), and time of sale to determine condo assessed values. The features in the table below are the ones used in the 2024 assessment model. | |||
| Because our individual condo unit characteristics are sparse and incomplete, we primarily must rely on aggregate geospatial features, economic features, [strata](#condo-strata), and time of sale to determine condo assessed values. The features in the table below are the ones used in the most recent assessment model. | |||
There was a problem hiding this comment.
"Most recent" is definitely fine.
Comment on lines
+208
to
+212
| We maintain a few useful resources for working with these features: | ||
|
|
||
| - Once you've [pulled the input data](#getting-data), you can inner join the data to the CSV version of the data dictionary ([`docs/data-dict.csv`](./docs/data-dict.csv)) to filter for only the features that we use in the model. | ||
| - You can browse our [data catalog](https://ccao-data.github.io/data-architecture/#!/overview) to see more details about these features, in particular the [condo model input view](https://ccao-data.github.io/data-architecture/#!/model/model.ccao_data_athena.model.vw_pin_condo_input) which is the source of our training data. | ||
| - You can use the [`ccao` R package](https://ccao-data.github.io/ccao/) or its [Python equivalent](https://ccao-data.github.io/ccao/python/) to programmatically convert variable names to their human-readable versions ([`ccao::vars_rename()`](https://ccao-data.github.io/ccao/reference/vars_rename.html)) or convert numerically-encoded variables to human-readable values ([`ccao::vars_recode()`](https://ccao-data.github.io/ccao/reference/vars_recode.html). The [`ccao::vars_dict` object](https://ccao-data.github.io/ccao/reference/vars_dict.html) is also useful for inspecting the raw crosswalk that powers the rename and recode functions. |
There was a problem hiding this comment.
I think this is totally fine for now. We can consolidate later when we do a rewrite.
dfsnow
deleted the
jeancochrane/72-missing-data-dictionary-incorrect-feature-table-values
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the condo model version of ccao-data/model-res-avm#315. We also make use of the changes in ccao-data/ccao#36 to remove dupes from the data dict and the
Features Usedtable in the README.Closes #72.