Fix count_alliance_records() documentation - add default values and improve parameter descriptions#25
Draft
Copilot wants to merge 2 commits into
Draft
Fix count_alliance_records() documentation - add default values and improve parameter descriptions#25Copilot wants to merge 2 commits into
Copilot wants to merge 2 commits into
Conversation
… record_lvl description Co-authored-by: allenbaron <21225409+allenbaron@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Correct documentation of count_alliance_records()
Fix count_alliance_records() documentation - add default values and improve parameter descriptions
Jun 30, 2025
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
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 corrects the documentation for the
count_alliance_records()function by addressing two key issues:Changes Made
Added default values to all parameter documentation: All parameters now clearly show their default values in parentheses:
term_subset(default: NULL)by_type(default: TRUE)pivot(default: TRUE)record_lvl(default: "disease-object")assign_to(default: "species")Improved
record_lvlparameter description: Changed from the incomplete description "a string indicating the desired specificity of records." to "a string indicating the desired specificity of records; see details for options (default: "disease-object")" which properly references the comprehensive list of options documented in the Details section.Files Modified
R/alliance.R- Updated roxygen2 documentation commentsman/count_alliance_records.Rd- Updated generated documentation fileThe detailed options for
record_lvlremain properly documented in the function's Details section, which lists all four valid values: "full_record", "disease-object", "disease", and "object".Fixes #8.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
cloud.r-project.org/usr/lib/R/bin/exec/R -e install.packages(c('roxygen2',~+~'devtools'),~+~repos='REDACTED')(dns block)esm.ubuntu.com/usr/lib/apt/methods/https(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.