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

Extend documentation and tests for pre and post processing #208

Merged
merged 72 commits into from Mar 26, 2023
Merged

Conversation

seabbs
Copy link
Collaborator

@seabbs seabbs commented Mar 25, 2023

This PR adds tests and documentation for all pre and post-processing functions for which this was missing. It also adds examples where these were missing for documented functions. Note that the documentation and tests are all a first pass and will likely need improvement over time.

In making these examples it also adds support for no.group variable in all preprocessing functions via the addition of a new internal helper function add_group().

Finally it resolves the spurious test warnings for snapshot tests which were linked to unstated formatting requirements.

In going through the pre/post processing I think both could do with a rethink/refactor in the future.

@seabbs seabbs added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 25, 2023
@seabbs seabbs requested a review from pearsonca March 26, 2023 18:43
Copy link
Collaborator

@pearsonca pearsonca left a comment

Choose a reason for hiding this comment

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

Soooooo...probably want to squash when doing this merge.

R/check.R Outdated Show resolved Hide resolved
R/formula-tools.R Outdated Show resolved Hide resolved
R/methods.R Outdated Show resolved Hide resolved
R/model-design-tools.R Outdated Show resolved Hide resolved
R/model-module-helpers.R Show resolved Hide resolved
R/preprocess.R Outdated Show resolved Hide resolved
R/preprocess.R Outdated Show resolved Hide resolved
R/preprocess.R Outdated Show resolved Hide resolved
R/preprocess.R Show resolved Hide resolved
R/preprocess.R Show resolved Hide resolved
seabbs and others added 17 commits March 26, 2023 21:36
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
@seabbs
Copy link
Collaborator Author

seabbs commented Mar 26, 2023

Soooooo...probably want to squash when doing this merge.

I did a great job on that manual review. Nice work with the suggested changes. In general, I am actually a really big fan of using squash merges for PRs.

@seabbs
Copy link
Collaborator Author

seabbs commented Mar 26, 2023

Thanks for the detailed and helpful review @pearsonca ❤️

@seabbs seabbs merged commit 8d3ef69 into develop Mar 26, 2023
7 checks passed
@seabbs seabbs deleted the extend-docs branch March 26, 2023 21:44
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 enhancement New feature or request
Projects
None yet
2 participants