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

Defensive programming / argument checks #116

Open
Tracked by #97
egouldo opened this issue Aug 15, 2024 · 0 comments
Open
Tracked by #97

Defensive programming / argument checks #116

egouldo opened this issue Aug 15, 2024 · 0 comments
Assignees
Labels
upkeep maintenance, infrastructure, and similar
Milestone

Comments

@egouldo
Copy link
Owner

egouldo commented Aug 15, 2024

egouldo added a commit that referenced this issue Aug 15, 2024
- #116 add checks for param table argument
- update default behaviour description #102
- line linting / indentation #97
- #88 change default behaviour to `process_response()`, not `standardise_response()` when `is.null(dataset_standardise)`, otherwise function did not allow for case when all datasets should not be Z-standardised
@egouldo egouldo self-assigned this Aug 15, 2024
@egouldo egouldo added the upkeep maintenance, infrastructure, and similar label Aug 15, 2024
@egouldo egouldo added this to the pkgdown milestone Aug 15, 2024
@egouldo egouldo linked a pull request Aug 15, 2024 that will close this issue
@egouldo egouldo reopened this Aug 15, 2024
egouldo added a commit that referenced this issue Aug 15, 2024
- #118 adapt response variable preparation to accept additional argument `dataset_log_transform` apply argument checks #116, add roxygen param #102
- #118 adapt response variable processing to accept either/or/none for dataset standardisation/log-transformation.
egouldo added a commit that referenced this issue Aug 15, 2024
egouldo added a commit that referenced this issue Aug 15, 2024
- #102 add import, return, and see also roxygen doc tags, replace note with details tag, rename fn doc title
- #116 update argument checks conditional expression
- #118 match output to `log_transform_yi()` (now returns additional cols `lower` and `upper`, not only `c("Z","VZ")`)
- #118 match process to `log_transform_yi()` and #97 generalise processing to both euc/bt datasets without hard-coding dataset names in fns, and remove associated dataset-specific argument checking #116
egouldo added a commit that referenced this issue Aug 15, 2024
- #116 check appropriate required variable (i.e. function needs `back_transformed_data`, but checked for `augmented_data` in `dat` arg, wouldn't throw required error because `augmented_data` was present in `dat`
egouldo added a commit that referenced this issue Aug 26, 2024
style: remove todo comments #97, shutup noisy joins by supplying `by` arg in join call.
egouldo added a commit that referenced this issue Aug 26, 2024
egouldo added a commit that referenced this issue Aug 27, 2024
- expose filtering of subsets to user argument: ignore outlier generation for some subsets
- Expose `n_min` and `n_max` args to user
- Add argument checks #116, inc. checking filter expressions for existance of col names in `data`
- Conditionally slice depending on whether `n_*` args supplied in call
- Define internal helper fns to reduce duplicate code
- Permit multiple logical expressions in argument ignore_subsets
- Allow different values of `n_min` and `n_max` for different `dataset`s

bug!: properly evaluate whether arg `ignore_subsets` is null and parse to `filter_vars`, see `dplyr::dplyr_data_masking`

docs!: Update docs #118

- include functional updates in roxygen docs #102
- rm targets pipeline family tag

style: tidy lint #97

- linespacing / whitespace
- rm TODO comments
- Add section header comments
egouldo added a commit that referenced this issue Aug 27, 2024
egouldo added a commit that referenced this issue Aug 28, 2024
- rm commented out `poss_fit_*()` (now exported internally in 7dabe6d) #97
- replace name of data arg to `data` #97
- switch to rlang::is_null for arg checking #116 / conditional behaviour
- Add arg checking for `filter_vars`, `data`, and checking wither required columns, incl. those in `filter_vars` exist in `data` #116
- expose user-supplied arguments `outcom_variable` / `outcome_SE` and match values to arg conditions in new columns
- update supply of colnames arg to meta-analysis functions

docs!: update corresponding docs #102

- switch to `@importFrom` for `cli::`, add missing `@importFrom` calls
- Add `@details` on user-specified exclusion of outcome variable / outcome variable SE

style: spacing indentation, rm inline TODO comments #97
egouldo added a commit that referenced this issue Aug 28, 2024
…118

- `fit_MA_mv()` switch from `Z_colname` to `outcome_colname` and `VZ_colname` to `outcome_SE_colname` #118
- `calculate_deviation_score()` #118:  expose colname selection column to user , return meta-analytic mean in column, add `outcome_colname` to specify relevant outcome column name, add argument checking #116
- `apply_slice_conditionally()` create column `exclusion_set` if does not exist and switch to `se_log` as `VZ_colname` in example for eucalyptus` #188
- `box_cox_transform()` expose `outcome_SE_colname` arg, add relevant arg checks, update cli output, parse outcome_SE_columns` to `folded_params()` function call #188
- replace `std.error_log` arg with `se_log` for any logged `yi` data #188
- and update wrapper function calls in `meta_analyse_datasets()`, provide NULL default for new arg `outcome_SE` #188
- `fit_box_cox_ratings_cat()`: add arg checks #116, replace arg name `.data` with `data`, switch to `inject` approach as per `fit_box_cox_ratings_cont()` #97
- fit_box_cox_ratings_cont()` switch to `data` arg from `.data`, add arg checks #116
- add arg checks to `standardise_response()`, `fit_sorensen_glm()`, `fit_multivar_MA()` , `fit_uni_mixed_effects()` #116

docs!: update corresponding docs

- delete obsolete `@examples` code #102
- add #TODO comments #97
- add missing `@import` calls
- switch to `@importFrom` from `@import` for `purrr::` `rlang::` and `tidyr::` et al
- don't import `rlang::` in package.R

bug!: minor bug fixes

- unquote bare colname in pointblank check for `exclude_extreme_VZ()`
- `fit_metafor_mv_reduced()` replace obs_id with study_id as random effect
egouldo added a commit that referenced this issue Aug 29, 2024
- Added conditional behaviour for when character vector supplied
- feat!: added arg checks #116 and cli output for when this condition is triggered

---

But wasn't failing for `yi` because `yi` received `rlang::expressions()` while `Zr` call used single length character variable for `outcome_variable` and `outcome_SE`
egouldo added a commit that referenced this issue Sep 6, 2024
After discarding NA values if the length is less than the number of inputs (4) THEN trigger the warning / early exit from fn. Threshold check was too low (3).
egouldo added a commit that referenced this issue Sep 10, 2024
egouldo added a commit that referenced this issue Sep 14, 2024
  - and add details explaining model structure and required data structure in roxygen documentation #102
  - don't pointblank check for box_cox column, let user's value be checked #116
  - update data checks to match required model structure #116
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
upkeep maintenance, infrastructure, and similar
Projects
None yet
Development

No branches or pull requests

1 participant