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

Reorganize and complete vignettes/chk_families.Rmd - "chk Families" docs #142

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

flor14
Copy link

@flor14 flor14 commented Oct 14, 2024

This PR:

  • Creates new titles ("or families") for chk package functions.
  • Adds text and examples to each family
  • Adds Advanced R as bibliography

Note: I have used "function input" instead of "function argument" on purpose. In general, we refer to the arguments passed by the user. I think saying "the function argument is a list" could be confusing, as it is not clear whether we are referring to the argument provided or how the function has been defined.

Therefore, I will use "function input" when referring to the argument provided and "function argument" when discussing how the function was designed. I will be consistent with this terminology throughout the documentation.

@flor14 flor14 changed the title Reorganizes and complete vignettes/chk_families.Rmd - "chk Families" docs Reorganize and complete vignettes/chk_families.Rmd - "chk Families" docs Oct 14, 2024
@flor14
Copy link
Author

flor14 commented Oct 21, 2024

This PR is probably the most critical. It provides a brief explanation and examples for most of the functions.

  • The titles and the way functions are grouped have changed. It is important to notice that there isn’t an organic way to do this. For example, chk_date and chk_date_time, could be part of Scalar Checkers as they were in the previous classification. Now I group them in the category Date Checkers. I tried to focus on what might be useful for a potential user. You may have comments on this.
  • Another decision I made was regarding the check_ functions. Initially, I tried to include them in this classification, but after exploring a bit, I realized that they consolidate several of the chk_ functions and seem to follow a different logic than the rest. So I keep them in a separate category. I don't know if there are plans to expand this package, but considering its complexity, check_ functions could eventually be developed into a separate package.
  • I also considered classifying the chk_ functions by the type of input. For example, chk_join() can only be applied to data frames. However, this classification seemed less useful for the user.

Once I receive feedback, I will edit this PR if necessary and include the final diagram.

Copy link
Member

@joethorley joethorley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants