print.ibd.var: print an ibd.var object

Description Usage Arguments Value See Also

View source: R/print.ibd.var.q

Description

Print results stored in an ibd.var object. If ped.id is NULL and sinkfile is NULL, print everything to a made-up sink file because the output is most likely too big for standard output. If ped.id is not NULL, print the ibd.var elements that match ped.ids. If sinkfile is not NULL, sink results to that file.

Usage

1
2
 ## S3 method for class 'ibd.var'
print(x, ped.id=NULL, sinkfile=NULL, digits=max(options()$digits - 2, 5), ...)

Arguments

x

An ibd.var object, created by either exact.ibd.var or sim.ibd.var

ped.id

Vector of pedigree IDs to specify a subset of the pedigrees to print

sinkfile

Name of file to sink too. Printed output from ibd.var is large, especially if ped.id is not given, so enforce a file name for where to sink print results. If ped.id is NULL and sinkfile is not given, default is set to name of x with ".sink".

digits

number of significant digits to print for numeric values

...

optional parameters for the print method

Value

nothing is returned

See Also

sim.ibd.var, exact.ibd.var, ibdreg


ibdreg documentation built on Sept. 5, 2021, 5:53 p.m.