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

Improve hts_validate_variable_list() roxygen documentation #163

Open
4 tasks
ashleyasmus opened this issue Jun 19, 2024 · 0 comments
Open
4 tasks

Improve hts_validate_variable_list() roxygen documentation #163

ashleyasmus opened this issue Jun 19, 2024 · 0 comments
Assignees

Comments

@ashleyasmus
Copy link
Collaborator

ashleyasmus commented Jun 19, 2024

  • In the documentation for hts_valdiate_variable_list, the argument variable_list is defined as 'Name of the variable to summarize. Default is NULL.' If the description is correct, then we should change the name of the argument to be 'variable_name', not 'variable_list'. Otherwise, if indeed it is looking for 'variable_list', the description of the argument should be changed.
  • There should be a link to hts_prep_variable in a See also section.
  • The name of this function is confusing. It is not validating a variable list, but rather cleaning it, right? (Or, what is it doing? I need more information about the "updating" it is doing in the description, see below.) If it is constructing and/or cleaning the variable list, it should be renamed to, 'hts_construct_variable_list.' or 'hts_clean_variable_list.'
  • This description, "Check that variable list has required elements for hts_prep_variable returns updated variable list or prompts error" should be edited to say, "Check that variable list has required elements for data summaries that are initialized in a related function, hts_prep_variable. Returns an updated variable list <with what new features?> or prompts error.
@ashleyasmus ashleyasmus changed the title Confusing hts_validate_variable_list() roxygen documentation Improve hts_validate_variable_list() roxygen documentation Jun 19, 2024
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

No branches or pull requests

2 participants