Skip to content

Commit

Permalink
forgot to doc verbose
Browse files Browse the repository at this point in the history
  • Loading branch information
smasongarrison committed May 22, 2024
1 parent 564339a commit f9fd577
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 1 deletion.
2 changes: 1 addition & 1 deletion R/summarizePedigree.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
#' @param skip_var A character vector of variables to skip when calculating summary statistics.
#' @param five_num_summary Logical, if TRUE, include the 5-number summary (min, Q1, median, Q3, max) in the summary statistics.
#' @param founder_sort_var The variable to sort the founders by. If NULL, the founders will be sorted by birth year (`byr`) if that's present and by `personID` otherwise.

#' @param verbose Logical, if TRUE, print progress messages.
#' @returns A data.frame (or list) containing summary statistics for family, maternal, and paternal lines, as well as the 5 oldest and biggest lines.
#' @import data.table
#' @export
Expand Down
2 changes: 2 additions & 0 deletions man/summarizeFamilies.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/summarizeMatrilines.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/summarizePatrilines.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/summarizePedigrees.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f9fd577

Please sign in to comment.