Skip to content

Fix anova.drc() documentation to match actual behavior#178

Merged
hreinwald merged 2 commits intodevfrom
copilot/fix-anova-drc-documentation
Mar 27, 2026
Merged

Fix anova.drc() documentation to match actual behavior#178
hreinwald merged 2 commits intodevfrom
copilot/fix-anova-drc-documentation

Conversation

Copy link
Copy Markdown

Copilot AI commented Mar 27, 2026

anova.drc() docs claimed passing a single model produces a lack-of-fit test. The code actually calls stop("Use the function modelFit()"). Users hit this error with no prior warning from the documentation.

Changes

  • @description/@details: Removed false claim about single-model lack-of-fit support. Now states two models are required and directs to modelFit() for single-model assessment.
  • @param ...: Changed from generic "additional arguments" to explicitly document that a second drc object is expected.
  • @param test: Fixed incorrect "od" reference; now documents actual defaults ("F" for continuous, "Chisq" for binomial).
  • @return: Expanded to describe returned structure (class anova inheriting data.frame, column semantics).
  • @seealso: Added cross-references to modelFit(), drm(), logLik.drc(), summary.drc().
  • @examples: Added modelFit() usage example for discoverability.
  • Updated man/anova.drc.Rd and docs/reference/anova.drc.md to match.

No behavioral changes — documentation only.


💡 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.

…onse#42)

The old documentation incorrectly claimed that passing a single model to
anova() produces a lack-of-fit test. In reality, the code raises an error
directing users to modelFit(). Updated the roxygen2 docs, man page, and
pkgdown reference to accurately describe the two-model comparison behavior
and redirect single-model users to modelFit().

Agent-Logs-Url: https://github.com/hreinwald/drc/sessions/01a236a3-cca0-436a-b0ec-0030ecef7b7c

Co-authored-by: hreinwald <115988583+hreinwald@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix documentation for anova.drc() function Fix anova.drc() documentation to match actual behavior Mar 27, 2026
Copilot AI requested a review from hreinwald March 27, 2026 12:20
@hreinwald hreinwald marked this pull request as ready for review March 27, 2026 14:05
@hreinwald hreinwald merged commit 59ef4d2 into dev Mar 27, 2026
6 checks passed
@hreinwald hreinwald deleted the copilot/fix-anova-drc-documentation branch March 27, 2026 14:51
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.

2 participants