Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update repo read me for 2024 #40

Merged
merged 10 commits into from
Mar 20, 2024
Merged

Conversation

wrridgeway
Copy link
Member

No description provided.

@wrridgeway wrridgeway self-assigned this Mar 11, 2024
@wrridgeway wrridgeway linked an issue Mar 11, 2024 that may be closed by this pull request
@wrridgeway
Copy link
Member Author

Need to update public s3 data before this gets merged.

@wrridgeway wrridgeway marked this pull request as ready for review March 11, 2024 18:24
@wrridgeway wrridgeway added the documentation Improvements or additions to documentation label Mar 12, 2024
dfsnow

This comment was marked as outdated.

Copy link
Member

@dfsnow dfsnow left a comment

Choose a reason for hiding this comment

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

@wrridgeway the content additions here are good, but can you fix the line ending issues and re-request review please.

.gitignore Outdated
Copy link
Member

Choose a reason for hiding this comment

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

issue: Let's fix the line endings in this file.

Copy link
Member

Choose a reason for hiding this comment

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

issue: Likewise, for this file: fix the line endings an re-request review.

README.md Show resolved Hide resolved
Comment on lines -120 to -121
| Condominium Building Strata 1 | Meta | character | X |
| Condominium Building Strata 2 | Meta | character | X |
Copy link
Member

Choose a reason for hiding this comment

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

issue: Strata are definitely still features. Why are these booted?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good question.

Copy link
Member Author

Choose a reason for hiding this comment

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

So, we removed strata from the vars dict here. You okay with me adding it back?

Copy link
Member Author

@wrridgeway wrridgeway Mar 18, 2024

Choose a reason for hiding this comment

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

We should also wrap the current ccao PR before we merge this PR.

Copy link
Member

Choose a reason for hiding this comment

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

@wrridgeway. Hold up on the current ccao PR. Go check what @jeancochrane did for the res README. We're moving away from needing the vars_dict data to update the model READMEs. The only thing that should be added to vars_dict is stuff that needs to be recoded in the various pipelines. Sorry I didn't remember this sooner.

Copy link
Member Author

@wrridgeway wrridgeway Mar 18, 2024

Choose a reason for hiding this comment

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

I think I'm a little confused. In the res readme there's also an inner_join() against ccao::vars_dict for feature names which seems like it would mean all feature names have to be in that data?

Copy link
Member

Choose a reason for hiding this comment

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

That might actually be a mistake. I think that join should be reversed, with param_tbl on the left side and vars_dict left joined. Calling @jeancochrane to confirm.

Copy link
Contributor

Choose a reason for hiding this comment

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

@dfsnow Yup, I think that is indeed a bug. Looks like we had a conversation about the relevant code block where you suggested a different join method and I copy/pasted your suggestion such that I removed the correct order of the join (which still should have been a left join instead of an inner join). My bad for not thinking it through at the time!

Copy link
Member Author

Choose a reason for hiding this comment

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

Alright, in that case I'll work on wrapping up this PR then we can actually revert the CCAO package back a few merges I believe.

@wrridgeway
Copy link
Member Author

Line endings fixed, not sure how I missed that. Looking into why strata is missing from the readme now.

@wrridgeway wrridgeway marked this pull request as draft March 18, 2024 19:20
@wrridgeway wrridgeway requested a review from dfsnow March 18, 2024 19:21
@wrridgeway
Copy link
Member Author

wrridgeway commented Mar 19, 2024

Strata is BACK, baby. But I'm not super sure how we want to handle the input data on S3 now.

@wrridgeway wrridgeway marked this pull request as ready for review March 19, 2024 21:05
Copy link
Member

@dfsnow dfsnow left a comment

Choose a reason for hiding this comment

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

@wrridgeway Some minor language edits here, but then good to go.

README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
@wrridgeway wrridgeway merged commit 3b6bf8c into master Mar 20, 2024
4 checks passed
@wrridgeway wrridgeway deleted the 39-update-repo-read-me-for-2024 branch March 20, 2024 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update repo read me for 2024
3 participants