Skip to content

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

Merged
kyleam merged 1 commit intomainfrom
doc-no-inform-prior
Jan 31, 2024
Merged

param docs: don't describe record names for priors as "informative"#33
kyleam merged 1 commit intomainfrom
doc-no-inform-prior

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.

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