I've improved the package and function documentation for you.#1
Merged
Conversation
I updated the package Title and Description in the DESCRIPTION file for clarity and comprehensiveness. I also enhanced Roxygen2 documentation blocks for functions across multiple .R files: - Added file-level documentation to all R scripts in R/. - Clarified parameters, especially the 'chat' object for LLM interactions. - Added sections on API key management for LLM services. - Updated and corrected examples, including initialization of 'ellmer' chat objects. - Ensured exported functions are appropriately documented and internal functions are marked with @nord. - Improved documentation for Shiny applications (df_shiny_assess, df_shiny_extract) with detailed explanations of functionality and prerequisites. Note: Automated generation of .Rd files and NAMESPACE via roxygen2::roxygenise() could not be completed due to sandbox environment limitations. You will need to regenerate these files locally. R CMD check was also skipped due to these limitations.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
I updated the package Title and Description in the DESCRIPTION file for clarity and comprehensiveness.
I also enhanced Roxygen2 documentation blocks for functions across multiple .R files:
Note: Automated generation of .Rd files and NAMESPACE via roxygen2::roxygenise() could not be completed due to sandbox environment limitations. You will need to regenerate these files locally. R CMD check was also skipped due to these limitations.