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

230 abstract config file parsing #288

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

anthonyjlau
Copy link
Collaborator

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.

Added get  functions for mbox, jira,        and github.
Copy link

codecov bot commented Mar 26, 2024

Codecov Report

Attention: Patch coverage is 0% with 244 lines in your changes are missing coverage. Please review.

Project coverage is 35.90%. Comparing base (2bc8d14) to head (ba27309).
Report is 3 commits behind head on master.

Files Patch % Lines
R/config.R 0.00% 244 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

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.
Copy link
Collaborator

@ian-lastname ian-lastname left a comment

Choose a reason for hiding this comment

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

Looks fine to me, documentation seems good enough for what it does.

@Ssunoo2
Copy link
Collaborator

Ssunoo2 commented Mar 28, 2024

Nice work!

anthonyjlau and others added 5 commits April 2, 2024 18:32
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.
@carlosparadis
Copy link
Member

@anthonyjlau Error occurs on my local machine too when I try to build it fails with the following error:

Error in parse(outFile) : 
  /Users/cvp/Desktop/kaiaulu/kaiaulu/R/config.R:770:68: unexpected symbol
769: 
770:   key <- conf[["issue_tracker"]][["bugzilla"]][["project_key_index"project_key

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants