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 readability of analyze function documentation #1130

Open
edelarua opened this issue Nov 8, 2023 · 2 comments
Open

Improve readability of analyze function documentation #1130

edelarua opened this issue Nov 8, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement sme

Comments

@edelarua
Copy link
Contributor

edelarua commented Nov 8, 2023

Similar to #1129, make it easier for the user to read & find information about the analyze function on shared documentation pages. Since statistics/analysis functions are not intended for use by the average tern user, we can give the analyze functions precendence in documentation pages by assigning them the @order 1 roxygen tag.

@edelarua edelarua added documentation Improvements or additions to documentation enhancement sme labels Nov 8, 2023
@edelarua edelarua self-assigned this Nov 8, 2023
@Melkiades
Copy link
Contributor

Thanks for this Emily!! Reading your comment here, I was thinking that we might add the list of summary functions to the README and intro vignette so to show users how to check if their functionality is already somehow present. What do you think?

@edelarua
Copy link
Contributor Author

edelarua commented Nov 9, 2023

Sounds good! I think any vignette changes should definitely be in a separate issue if you want to create one for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement sme
Projects
None yet
Development

No branches or pull requests

2 participants