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.

Sign up for GitHub

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

Jump to bottom

Inconsistent documentation on cluster_gen_* subfunctions #52

Open
wleoncio opened this issue Sep 10, 2024 · 0 comments
Open

Inconsistent documentation on cluster_gen_* subfunctions #52

wleoncio opened this issue Sep 10, 2024 · 0 comments
Assignees
@wleoncio
Labels
bug

Comments

@wleoncio
Copy link
Collaborator

They should use @inheritParams cluster_gen, but watch out for the fact that the subfunctions contain details missing from cluster_gen()! For example, on cluster_gen_separate():

#' @param sampling_method can be "SRS" for Simple Random Sampling or "PPS" for Probabilities Proportional to Size, "mixed" to use SRS for students and PPS otherwise or a vector with the sampling method for each level

On cluster_gen(), there's no explanation of how "mixed" works, even though it is the default. ☠️
@wleoncio wleoncio added the bug label Sep 10, 2024
@wleoncio wleoncio self-assigned this Sep 10, 2024
wleoncio added a commit that referenced this issue Sep 11, 2024
@wleoncio
Improved documentation of cluster_gen* (#52)
e7ff981
wleoncio added a commit that referenced this issue Sep 11, 2024
@wleoncio
Improved documentation for N (#52)
3a60890
wleoncio added a commit that referenced this issue Sep 11, 2024
@wleoncio
Added tests for #52
9e5d3fc
wleoncio added a commit that referenced this issue Sep 11, 2024
@wleoncio
Improved documentation for sampling_method (#52)
36e9171
wleoncio added a commit that referenced this issue Sep 11, 2024
@wleoncio
Merge branch 'issue-52' into develop
5fe6d5d 
* issue-52:
  Fixed links in `@seealso`
  Added links to `@seealso` entries
  Updated NEWS.md
  Proper markdown formatting of docs
  Increment version number to 2.1.5.9002
  Improved documentation for `sampling_method` (#52)
  Added tests for #52
  Improved documentation for `N` (#52)
  Improved documentation of `cluster_gen*` (#52)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wleoncio wleoncio

Labels
bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@wleoncio