230 abstract config file parsing #288
Open
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
Added get functions for mbox, jira, and github.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #288 +/- ##
==========================================
- Coverage 39.79% 35.90% -3.89%
==========================================
Files 20 21 +1
Lines 3091 3545 +454
==========================================
+ Hits 1230 1273 +43
- Misses 1861 2272 +411 ☔ View full report in Codecov by Sentry. |
Functions that require something from a list (ie. conf[["version_control"]][["branch"]][4]) now have an index parameter. (ie. conf[["version_control"]][["branch"]][branch_index]) Also finished the rest of the get methods for all notebooks.
I normalized the comments by having it follow a format. I added if wrappers to catch null values.
|
Nice work! |
I changed the documentation of the JIRA functions to return a list of project keys and storage paths (HADOOP case). I also changed the documentation of the mbox function to return a list of storage paths.
|
@anthonyjlau Error occurs on my local machine too when I try to build it fails with the following error: |
Confirming setup for committing and PR reflection.
Confirming setup for committing and PR reflection.
In each notebook, the working directory is the vignettes/ directory, however, the getwd() command states that the working directory is the kaiaulu/ folder itself. This is because each R code chunk considers its directory to be the working directory. To test the functionality of the get functions, I edited the config file to reflect the relative directory of vignettes/, thus parent directory ../ file path changes were added to each function.
beydlern
force-pushed
the
230-abstract-config-file-parsing
branch
from
7adaf4f
to
ef42bd3
Compare
The source("../R/config.R") reference was previously used to import the get() functions from config.R, however I wasn't building the project correctly. Now, this incorrect reference can be removed.
Due to a minor misunderstanding on my part, I added in relative paths in the config.R file from the notebook's directory, this was due to the IDE RStudio changing the working directory to the current running notebook directory rather than staying at the project directory.
- Function titles, descriptions, and parameter documentation were reviewed and redefined. - Removed inefficient hardcoding of tools.yml and duplicated "config" path code. - Appropriate warning messages were added to each function in the case of the return value possessing the NULL value. - Notebook blamed_line_types_showcase.Rmd was updated to reflect follow the redefined R/config.R get functions.
daomcgill
reviewed
Sep 27, 2024
There was a problem hiding this comment.
I made some in-line comments for some ideas on how you can make the function signatures and comments clearer. I did not do all of them, but you should retain a consistent level of detail throughout the file. Even though some code already seems simple, it is still easier to read in words.
- config.R was modified to possess descriptive get function titles and descriptions as well as a separation of getter functions into groups for clarity. - Some appropriate notebooks (every notebook in vignettes/ that doesn't have an "_" prefix) were decoupled to use the get() functions from config.R in lieu of hard-coded paths to the configuration files.
- Updated mailing_list for conf/ files - Updated issue_tracker for conf/ files
…/sailuh/kaiaulu into 230-abstract-config-file-parsing
carlosparadis
requested changes
Oct 3, 2024
- Refactored most of the notebooks to replace the hard coded paths with the getter functions in R/config.R - Updated a few of the configuration files (.yml extension) in conf/ fixing some syntax and indentation errors - Added another getter function in R/config.r called get_github_issue_event_path - Edited DESCRIPTION to incorporate myself as a contributor - Edited NEWS.md to describe refactoring getter function feature.
- config_file parameter description was incorrect, a reference to how it is obtained was added to its description. - renamed get_parsed() to parse_config() and changed the appropriate getter calls in all of the notebooks. - reverted RoxygenNote version in DESCRIPTION
- config.R functions are organized to follow the same formatting as the conf files - All conf files issue_trackers have been updated.
- get_mbox_mailing_list() and get_mbox_archive_type() were removed as the keys that they are grabbing are scheduled for removal.
- added two new bugzilla getter functions get_bugzilla_issue_comment_path and get_bugzilla_issue_path
- Implemented two pipermail mailing list getters get_pipermail_domain and get_pipermail_path
- Implemented two more getter functions: get_mbox_input_file() and get_pipermail_input_file()
- Added Scitools understand section to tools - Updated mailing_list
- Implemented 4 Getter functions: get_understand_code_language(), get_understand_keep_dependencies_type(), get_understand_project_path(), and get_understand_output_path(). - Changed get_code_language() and get_keep_dependencies_type() to get_depends_code_language() and get_depends_keep_dependencies_type(), respectively as well as updated the appropriate notebooks that used these getters.
|
Nice to see these checks passing at last, thank you for merging the master to fix on this end! |
- Updated NEWS.md - Minor change to mailing_list
|
Made 1 new commit after group meeting, updated NEWS.md and a very minor change to the mailing_list. |
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.
If a change is made in a configuration file, then every notebook that uses that configuration file has to be changed. In order to centralize the process and make it easier to change configuration files, the R/config.R file will store "get" functions that get the fields from the config files. These get functions can be used in place of the hard coded variable assignments. It will also make it easier to update changes to config files as only the functions in R/config.R need to be updated.