Inspect declared inputs without constructing a phylogenetic graph or fitting
a model. The check is intended to make input problems and likely compute
scale visible before calling impute(). Its fingerprint identifies the
declared input object for comparison within a workflow; it is not a security
hash.
Usage
check_pigauto(
traits,
tree,
species_col = NULL,
trait_types = NULL,
multi_proportion_groups = NULL
)Arguments
- traits
A data.frame of traits, with row names or a species column.
- tree
A
phylotree.- species_col
Optional column naming species identities.
- trait_types
Optional named type overrides passed to
preprocess_traits().- multi_proportion_groups
Optional named composition groups passed to
preprocess_traits().
Value
A list of class pigauto_check containing a schema version, status,
stable input fingerprint, input summaries, and structured messages.
Examples
# \donttest{
tree <- ape::read.tree(text = "((a:1,b:1):1,c:2);")
traits <- data.frame(x = c(1, NA, 3), row.names = tree$tip.label)
check_pigauto(traits, tree)
#> pigauto input check: ready
# }