Skip to content

Commit

Permalink
typo
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderFengler committed Jan 1, 2025
1 parent 175bb1c commit 80fd809
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/getting_started/hierarchical_modeling.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@
"\n",
"### **BREAKING CHANGES:** Use `global_formula` instead of `hierarchical` parameter when creating an HSSM model\n",
"\n",
"In HSSM v0.3.0, we have removed the `hierarchical` parameter to the `hssm.HSSM` class. In older versions, HSSM had a `hierarchical` argument which was a `bool`. It serves as a convenient switch to add a random-intercept regression to any parameter that is not explicitly defined by the user, using `participant_id` as a grouping variable.\n",
"In HSSM v0.2.5, we have removed the `hierarchical` parameter to the `hssm.HSSM` class. In older versions, HSSM had a `hierarchical` argument which was a `bool`. It serves as a convenient switch to add a random-intercept regression to any parameter that is not explicitly defined by the user, using `participant_id` as a grouping variable.\n",
"\n",
"However, this `hierarchical` parameter caused much confusion, because many believed that somehow `hierarchical` would magically turn the model into a hierarchical model, while in reality, it does nothing more than adding a `y ~ 1 + (1|participant_id)` to all parameter, where `y` stands for the name of that parameter. That is why we removed this confusing parameter in favor of the new `global_formula` parameter, which is less confusing and offers the users more convenience and transparent control over the models that they want to create.\n",
"\n",
Expand Down

0 comments on commit 80fd809

Please sign in to comment.