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

Document the use of the summary function in readme/intro vignette #184

Closed
tomjemmett opened this issue Jul 18, 2023 · 1 comment · Fixed by #198
Closed

Document the use of the summary function in readme/intro vignette #184

tomjemmett opened this issue Jul 18, 2023 · 1 comment · Fixed by #198
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@tomjemmett
Copy link
Member

The solution for #164 already exists in the form of the summary() method. However, this method is not mentioned in the Readme or intro vignette.

We could do with a paragraph in both of these showing how you can use summary to get some basic statistics about your spc data frame, and how this could be used (summary() prints the spc options, and then returns the summarised results. The main usage of summary() is in an interactive case, so this summarised table is typically also printed, but you could assign this table to a variable and use it later).

@tomjemmett tomjemmett added the documentation Improvements or additions to documentation label Jul 18, 2023
@tomjemmett tomjemmett added this to the 0.2.0 milestone Jul 18, 2023
@tomjemmett tomjemmett added the good first issue Good for newcomers label Jul 18, 2023
@marcosfabietti
Copy link
Contributor

#198

created pull request for it, please review

@tomjemmett tomjemmett linked a pull request Dec 9, 2023 that will close this issue
5 tasks
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 good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants