317 Openhub API Interface Functions #325
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.
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.
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.
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.
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.
- 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
- 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.
- The functions, openhub_api_analyses, openhub_api_iterate_pages, openhub_api_organizations, openhub_api_portfolio_projects, openhub_api_projects, openhub_parse_analyses, openhub_parse_organizations, openhub_parse_portfolio_projects, and openhub_parse_projects, were implemented (WITHOUT DOCUMENTATION). - A notebook, openhub_project_search, demonstrating the capability of interacting with the OpenHub project database through the Ohloh API to search for projects has been implemented.
29 tasks
- Documentation builder functions incorrectly updated RoxygenNote version, this commit reverts this change.
beydlern
force-pushed
the
317-openhub-api-interfacing
branch
from
5ddd5e8 to
a8db840
Compare
- Added function documentation to all openhub API interfacing functions.
- openhub_project_search.Rmd had documentation added to describe the project gathering process. - R/config.R removed and commented out print statements for cleaner output from the openhub_* functions.
- openhub_project_search.Rmd was updated for each section of code not to be evaluated upon knitting and the explanation texts were updated for better clarity.
- config.R: added primary_language to openhub_parse_portfolio_projects, added html_url and mailing_list to openhub_parse_projects, added min_month and code_languages to openhub_parse_analyses. - openhub_project_search.Rmd: incorporated the config.R changes (primary_language, html_url, mailing_list, min_month, and code_languages) under each respective section.
- openhub_project_search.Rmd was updated to include a pointer to verify if a project labels its commits with issue IDs.
- openhub_project_search.Rmd was updated by shifting around the content to allow users to grasp the focal point of the notebook at first glance (motivation subsection).
- Added the information about the OpenHub interfacing functions to _pkgdown.yml. - Added the feature description of the OpenHub interfacing feature to NEWS.md.
|
@beydlern I tried running through your notebook, and everything seems to be in working order. I think it looks good. |
- All configuration files had a new section added for openhub and its folders for storage. - openhub_project_search was updated to refine the motivation section and to change the data table display function (from kable library to gt library).
- The current working version of the notebook and functions to search for projects (Downloaders and Parsers are not yet generalized and still contain overloading functionality, which is to be resolved and implemented in the notebook, openhub_project_search.Rmd).
- In config.R, the organization downloader and parser as well as the portfolio project downloader and parser were refactored to become more generalized and work with the iterator function, openhub_api_iterate_pages().
- In config.R, the project downloader and parser as well as the analysis downloader and parser were refactored to become more generalized and work with the iterator function, openhub_api_iterate_pages().
- config.R, the openhub interfacing functions had their documentation updated. - openhub_project_search.Rmd, revised the notebook with up-to-date information.
- Modified openhub_parse_projects() overloaded functionality (using regex pattern to search for mailing list) to simply extract the list of project links (if available).
- The openhub_parse_projects() function returns two tables, one about the project's specific data and the other about the project's external links. The notebook, openhub_project_search.Rmd, has been updated to reflect these changes.
- Incorrect table was being merged, fixed in notebook.
- openhub_parse_projects() the project_links data table had a field added (column added), which is the project ID. The notebook, openhub_project_search.Rmd, has been updated to reflect these changes.
29 tasks
carlosparadis
requested changes
Dec 9, 2024
- All description tags for function documentations were removed in config.R. - Data tables are displayed using pipe operators with gt() function and head() function in openhub_project_search.Rmd. - Parser sections have their "eval = FALSE" removed for their code blocks in openhub_project_search.Rmd. - Removed "invisible()" function from all functions in config.R.
- Added OpenHub API interfacing functions to _pkgdown.yml. - Added missing parameter function documentation to openhub_download function in config.R. - Removed debug print statements openhub_api_iterate_pages in config.R.
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.
temp_max_number_of_portfolio_projects_pages_to_search_throughis a temporary variable (renamed in the future) that will limit the number of pages theopenhub_api_portfolio_projectsfunction will request to not consume too many API requests when testing, currently set to1(one page)).