Implement New Approach to DECAF Client #2
Merged
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
- Update the description of the package - Upgrade Roxygen version and allow markdown markup - Suggest testthat (to be used later)
- Use MIT license - Update copyright holders
Roxygen has improved output formatting since we have last used it.
As a starter, let's rename all files to indicate that all current functionality is deprecated (although some definitions may be reused as is or with some changes). This allows us a clean sheet for creating new definitions in their own source files.
We will ignore all existing source files as we do not want to clutter the change history for these files and they may be irrelevant as we move on.
This commit provides us with the lowest-level HTTP client interface that is ready to place HTTP requests to any DECAF Instance API. New functionality is added with at least *some* meaningful documentation. Furthermore, this commit also starts unit testing practice for this library (based on testthat).
fkoksal
approved these changes
Jan 12, 2022
- Revisit function documentation. - Fix a small bug.
Seems like R6 and crul were not listed in NAMESPACE.
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.
This PR is for adopting the new approach to DECAF API client implementations that we have employed in other language libraries.
This is going to allow us to extend the reach of DECAF API client beyond DECAF Barista. Furthermore, we are revisiting how profile configurations are defined, stored and retrieved.
Lastly, we are trying to catch-up with changing best-practices in R package development (tests, linters, static analysis, etc...).
Closes #1.