Add parameter definitions to summarize.R #41
Conversation
Signed-off-by: Awa Synthia <[email protected]>
Signed-off-by: Awa Synthia <[email protected]>
the-mayer
added
the
documentation
- add back importFrom n_distinct() as it appears to be used by summarizeGenContext() - use function call as title -- may specify this in MolEvolvR style guide for consistency - adjust Rd grouping with MolEvolvR_summary @Rdname tag for functions that had a clear summary element. This will hopefully avoid confusion with the rather ubiquitous dplyr::summarize - converted some code comments to placeholder descriptions
| @@ -10,7 +10,7 @@ | |||
| # suppressPackageStartupMessages(library(rlang)) | |||
| # conflicted::conflict_prefer("filter", "dplyr") | |||
|
|
|||
| #' Filter by Domains | |||
| #' filterByDomains | |||
There was a problem hiding this comment.
for consistency, modified the titles of function documentation to the function call.
| #' MolEvolvR Summary | ||
| #' @name MolEvolvR_summary | ||
| #' @description | ||
| #' A collection of summary functions for the MolEvolvR package. | ||
| #' | ||
| NULL | ||
|
|
||
| #' summarizeByLineage |
There was a problem hiding this comment.
Created a MolEvolvR_summary Rd block
| #' @return A tibble summarizing the counts of occurrences of elements in | ||
| #' the `column`, grouped by the `by` column. The result includes the number | ||
| #' of occurrences (`count`) and is arranged in descending order of count. | ||
| #' @rdname MolEvolvR_summary |
There was a problem hiding this comment.
Grouped summary functions under MolEvolvR_summary with @Rdname
There was a problem hiding this comment.
Thanks @awasyn ! Great work on adding descriptions to the parameters and returns for these functions! I made a few changes, mostly to the way the Rd files are grouped within summarize.R. I used @Rdname, instead of @name and grouped the summary functions under a common heading MolEvolvR_summary -- credit to you for recognizing the similar functionality!
Additionally, I made some minor stylistic adjustments, which we may wish to apply to other function documentation. Will tag in future issues.
Merging shortly!
Description
What kind of change(s) are included?
Checklist
Please ensure that all boxes are checked before indicating that this pull request is ready for review.