Skip to content

Fix count_alliance_records() documentation - add default values and improve parameter descriptions#25

Draft
Copilot wants to merge 2 commits into
mainfrom
copilot/fix-8
Draft

Fix count_alliance_records() documentation - add default values and improve parameter descriptions#25
Copilot wants to merge 2 commits into
mainfrom
copilot/fix-8

Conversation

Copy link
Copy Markdown

Copilot AI commented Jun 30, 2025

This PR corrects the documentation for the count_alliance_records() function by addressing two key issues:

Changes Made

  1. 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")
  2. Improved record_lvl parameter 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 comments
  • man/count_alliance_records.Rd - Updated generated documentation file

The detailed options for record_lvl remain 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
    • Triggering command: /usr/lib/R/bin/exec/R -e install.packages(c('roxygen2',~+~'devtools'),~+~repos='REDACTED') (dns block)
  • esm.ubuntu.com
    • Triggering command: /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.

… 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
Copilot AI requested a review from allenbaron June 30, 2025 14:19
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.

Correct documentation of count_alliance_records()

2 participants