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

naming of functions #25

Closed
dramanica opened this issue Apr 17, 2024 · 1 comment · Fixed by #30
Closed

naming of functions #25

dramanica opened this issue Apr 17, 2024 · 1 comment · Fixed by #30
Labels
enhancement New feature or request

Comments

@dramanica
Copy link
Member

We need a bit of clean up of names. The suggested logic is that:

  • 'indiv' is used as a prefix for functions applied at the individual (row) level, e.g. indiv_missingness().
  • 'loci' is used as a prefix for functions at the locus (column) level, e.g. loci_missingness().
  • 'gt' is used for functions that apply to the whole gen_tibble, e.g. gt_pca

We need to think about functions that make pairwise comparisons (e.g. ibs, king, pairwise_pop_fst). One option is to use the prefix between_. However, this can be ambiguous, as a between_ function would return a matrix that could be n x n individuals, or m by m populations. One option is to say that between_ functions return a matrix of comparisons between individuals, and that between_pop_ is used for populations. So, we would have between_ibs or between_king and between_pop_fst.

@dramanica dramanica added the enhancement New feature or request label Apr 17, 2024
@dramanica
Copy link
Member Author

Since between is a dplyr function, we will switch to pairwise_*.

@dramanica dramanica mentioned this issue May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant