diff --git a/R/summarizePedigree.R b/R/summarizePedigree.R index d6e9158..f4d605a 100644 --- a/R/summarizePedigree.R +++ b/R/summarizePedigree.R @@ -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 diff --git a/man/summarizeFamilies.Rd b/man/summarizeFamilies.Rd index b755d1d..85f148d 100644 --- a/man/summarizeFamilies.Rd +++ b/man/summarizeFamilies.Rd @@ -47,6 +47,8 @@ summarizeFamilies( \item{skip_var}{A character vector of variables to skip when calculating summary statistics.} \item{five_num_summary}{Logical, if TRUE, include the 5-number summary (min, Q1, median, Q3, max) in the summary statistics.} + +\item{verbose}{Logical, if TRUE, print progress messages.} } \description{ Summarize the families in a pedigree diff --git a/man/summarizeMatrilines.Rd b/man/summarizeMatrilines.Rd index 4e3f4b3..42edca5 100644 --- a/man/summarizeMatrilines.Rd +++ b/man/summarizeMatrilines.Rd @@ -47,6 +47,8 @@ summarizeMatrilines( \item{skip_var}{A character vector of variables to skip when calculating summary statistics.} \item{five_num_summary}{Logical, if TRUE, include the 5-number summary (min, Q1, median, Q3, max) in the summary statistics.} + +\item{verbose}{Logical, if TRUE, print progress messages.} } \description{ Summarize the maternal lines in a pedigree diff --git a/man/summarizePatrilines.Rd b/man/summarizePatrilines.Rd index 3f6ff2a..d85b366 100644 --- a/man/summarizePatrilines.Rd +++ b/man/summarizePatrilines.Rd @@ -47,6 +47,8 @@ summarizePatrilines( \item{skip_var}{A character vector of variables to skip when calculating summary statistics.} \item{five_num_summary}{Logical, if TRUE, include the 5-number summary (min, Q1, median, Q3, max) in the summary statistics.} + +\item{verbose}{Logical, if TRUE, print progress messages.} } \description{ Summarize the paternal lines in a pedigree diff --git a/man/summarizePedigrees.Rd b/man/summarizePedigrees.Rd index 59a0e0c..1f29e24 100644 --- a/man/summarizePedigrees.Rd +++ b/man/summarizePedigrees.Rd @@ -50,6 +50,8 @@ summarizePedigrees( \item{skip_var}{A character vector of variables to skip when calculating summary statistics.} \item{five_num_summary}{Logical, if TRUE, include the 5-number summary (min, Q1, median, Q3, max) in the summary statistics.} + +\item{verbose}{Logical, if TRUE, print progress messages.} } \value{ A data.frame (or list) containing summary statistics for family, maternal, and paternal lines, as well as the 5 oldest and biggest lines.