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

Error in documentation for ProbitLogNormal class #799

Open
2 tasks
Puzzled-Face opened this issue Mar 1, 2024 · 0 comments
Open
2 tasks

Error in documentation for ProbitLogNormal class #799

Puzzled-Face opened this issue Mar 1, 2024 · 0 comments
Labels
bug Something isn't working documentation Improve documentation good first issue Good for newcomers

Comments

@Puzzled-Face
Copy link
Collaborator

Puzzled-Face commented Mar 1, 2024

The documentation for the ProbitLogNormal class reads, in part,

This model is also used in the DualEndpoint classes...

which is not strictly true, because DualEndpoint supports both ProbitNormal [a class which does not exist] and ProbitLogNormal models through its use_log_dose slot. ProbitLogNormal has no such flag, so always uses log(x/x*) as a covariate in its model.

Suggestions

  • Amend the documentation for ProbitLogNormal to clarify that DualEndpoint's model is an extension of ProbitLogNormal.
  • [Optional] Create a ProbitNormal class to implement the missing model

Creation of the ProbitNormal class (and associated methods) should be straightforward, and would help with the implementation of knit_print methods for model classes. (See #796.) However, note that the name suggested here contradicts the nomenclature used in LogisticLogNormal and LogisticNormal, where the presence or absence of Log defines the prior, not the covariate.

@Puzzled-Face Puzzled-Face added bug Something isn't working good first issue Good for newcomers documentation Improve documentation labels Mar 1, 2024
@Puzzled-Face Puzzled-Face removed bug Something isn't working good first issue Good for newcomers documentation Improve documentation labels Mar 1, 2024
@Puzzled-Face Puzzled-Face reopened this Mar 1, 2024
@Puzzled-Face Puzzled-Face added bug Something isn't working good first issue Good for newcomers documentation Improve documentation labels Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improve documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant