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

[Feature request]: overhaul flepiconfig to current config schema, a to use yaml::write_yaml #459

Open
pearsonca opened this issue Jan 8, 2025 · 2 comments
Labels
enhancement Request for improvement or addition of new feature(s). low priority Low priority. r-flepiconfig Relating to the R configuration package.

Comments

@pearsonca
Copy link
Contributor

pearsonca commented Jan 8, 2025

Label

dependency, r-flepiconfig

Priority Label

medium priority

Describe the bug/issue

the flepiconfig package no longer reflects the current configuration structure. additionally, the package imports the yaml package, but uses manual file writing to create configurations.

Desired Solution

flepiconfig should be re-written (with a breaking-indicating version change) to reflect the current configuration approach. ideally, flepiconfig will also deal with correctly assembling configuration file structures, so that future changes to config schema won't have big impacts on users code leveraging flepiconfig2.0

@pearsonca
Copy link
Contributor Author

pearsonca commented Jan 8, 2025

upstream of this: need to separate flepiconfig as its own R package, update flepimop to depend on specific (current) version and then in a future version of flepimop, update its dependencies to reflect the updated (breaking) flepiconfig.

then need to provide information on how to revert to old version of flepiconfig if needed to run some particular old script.

basically, need to let people use the old flepiconfig version if they need to, but start switching new applications / users over to updated version.

@TimothyWillard TimothyWillard added enhancement Request for improvement or addition of new feature(s). low priority Low priority. r-flepiconfig Relating to the R configuration package. labels Jan 10, 2025
@TimothyWillard TimothyWillard added this to the Software Quality milestone Jan 10, 2025
@pearsonca
Copy link
Contributor Author

There is one supporting infrastructure gap in yaml package: vubiostat/r-yaml#77 and/or vubiostat/r-yaml#123 - we really want to support the array style for user readability, and particularly some of our nested array syntax, while legal yaml, might not be convenient to output.

There is some work on a branch to support some of what we need, but I expect we will need to successully offer contributions against that project if we want to leverage it.

@TimothyWillard TimothyWillard changed the title [Refactor]: overhaul flepiconfig to current config schema, a to use yaml::write_yaml [Feature request]: overhaul flepiconfig to current config schema, a to use yaml::write_yaml Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Request for improvement or addition of new feature(s). low priority Low priority. r-flepiconfig Relating to the R configuration package.
Projects
None yet
Development

No branches or pull requests

2 participants