Skip to content

Commit

Permalink
param docs: don't describe record names for priors as "informative"
Browse files Browse the repository at this point in the history
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)
  • Loading branch information
kyleam committed Jan 30, 2024
1 parent 2885bc0 commit 0032655
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions R/extract-param.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
#' example, a record of `$THETA (1)x4` is returned as `c(1, NA, NA, NA)`.
#'
#' * If additional parameter records are used for priors, those are included in
#' the result. To avoid this, instead use informative prior record names
#' (such as `THETAP` and `THETAPV`).
#' the result. To avoid this, instead use more specific record names (such as
#' `THETAP` and `THETAPV`).
#'
#' @param records An [nmrec_ctl_records] object.
#' @param mark_flags A vector of NONMEM flags (i.e. valueless options such as
Expand Down
4 changes: 2 additions & 2 deletions R/set-param.R
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
#'
#' * Using additional parameter records for priors is not supported and will
#' lead to a size mismatch between the parameter and its records. Instead use
#' informative prior record names (such as `THETAP` and `THETAPV`).
#' more specific record names (such as `THETAP` and `THETAPV`).
#'
#' @param records An [nmrec_ctl_records] object.
#' @param values Overwrite the parameter's initial estimates in `records` with
Expand Down Expand Up @@ -195,7 +195,7 @@ set_param <- function(records, name, values, fmt) {
),
"i" = paste0(
"If you're using ", toupper(name), " records for priors, ",
"please switch to informative record names ",
"please switch to more specific record names ",
"(such as THETAP and THETAPV)."
)
),
Expand Down
4 changes: 2 additions & 2 deletions man/extract_param.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/set_param.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 0032655

Please sign in to comment.