Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

param docs: don't describe record names for priors as "informative" #33

Merged
merged 1 commit into from
Jan 31, 2024

Conversation

kyleam
Copy link
Collaborator

@kyleam kyleam commented Jan 30, 2024

The set-param and extract-param docs call records like THETAP and THETAPV as "informative prior record names" because NONMEM refers to records like THETAP and THETAPV as "informative record names". However, that invites confusion with the unrelated statistical concept of informative/non-informative priors (even more so because the nmrec docs unnecessarily insert "prior" between "informative" and "record names").

Drop "informative" entirely to avoid confusion. While at it, reduce "prior record names" to "record names" because "prior" makes it harder to parse and is unnecessary given the context.

Thanks to @timwaterhouse for the suggestion.

Re: metrumresearchgroup/bbr#635 (comment)

The set-param and extract-param docs call records like THETAP and
THETAPV as "informative prior record names" because NONMEM refers to
records like THETAP and THETAPV as "informative record names".
However, that invites confusion with the unrelated statistical concept
of informative/non-informative priors (even more so because the nmrec
docs unnecessarily insert "prior" between "informative" and "record
names").

Drop "informative" entirely to avoid confusion.  While at it, reduce
"prior record names" to "record names" because "prior" makes it harder
to parse and is unnecessary given the context.

Thanks to @timwaterhouse for the suggestion.

Re: metrumresearchgroup/bbr#635 (comment)
@kyleam kyleam requested a review from barrettk January 30, 2024 22:42
Copy link
Collaborator

@barrettk barrettk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@kyleam
Copy link
Collaborator Author

kyleam commented Jan 31, 2024

@barrettk Thanks for taking a look.

@kyleam kyleam merged commit 1e76597 into main Jan 31, 2024
2 checks passed
@kyleam kyleam deleted the doc-no-inform-prior branch January 31, 2024 15:45
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