docs: correct registry description strings to match the implementation - #597
Merged
Conversation
Fixes #582. Replaces #590, which predates the 40-character desc limit and whose replacement strings run 63-243 characters. adj.r.squared.factor described itself as a factor multiplied by the number of data points and added to the adjusted r^2. The code instead accepts every regression whose adjusted r^2 is within adj.r.squared.factor of the best and picks the one using the most points. This string is built by paste() for PKNCA.options() and is not subject to the desc length limit. span.ratio described itself as the half-life divided by the calculation duration, the inverse of what half.life.R computes: ret$span.ratio <- (max(data$time) - min(data$time))/ret$half.life The roxygen for pk.calc.half.life() already described it the correct way, so the registry string also contradicted the manual page. The eight dose-aware aucint*/aumcint* parameters ending in .dose described themselves as AUCdn/AUMCdn. In this package `dn` means dose normalized (auclast.dn, aucinf.obs.dn), while these parameters use dose-aware interpolation -- as their own pretty_name has always said. All replacements are within the 40-character limit. The aucint.inf/aumcint.inf copy-paste that #590 also fixed is already correct on main; the new tests pin it so it stays that way. Tests enumerate the parameter sets rather than listing cases, so a newly added interval parameter is covered automatically. Co-Authored-By: Claude Opus 5 <[email protected]>
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.
Fixes #582. Replaces #590, which predates the 40-character
desclimit — itsreplacement strings run 63–243 characters and conflict in 9 places.
adj.r.squared.factordescribed itself as a factor multiplied by thenumber of data points and added to the adjusted r². The code instead accepts
every regression whose adjusted r² is within
adj.r.squared.factorof thebest and picks the one using the most points. Built by
paste()forPKNCA.options(), so not subject to the length limit.span.ratiodescribed itself as half-life ÷ duration, the inverse ofwhat
half.life.Rcomputes:(max(time) - min(time))/half.life. The roxygenfor
pk.calc.half.life()already had it right, so the registry string alsocontradicted the manual page.
aucint*/aumcint*parameters ending in.dosedescribed themselves as
AUCdn/AUMCdn. Herednmeans dose normalized(
auclast.dn,aucinf.obs.dn), while these use dose-aware interpolation —as their own
pretty_namehas always said. All replacements fit in 40 chars.The
aucint.inf/aumcint.infcopy-paste that #590 also fixed is alreadycorrect on main; the new tests pin it. Tests enumerate the parameter sets
rather than listing cases, so a newly added interval parameter is covered.