haplo_logfile: Generate the logfile of a haplotype analysis

Description Usage Arguments Details Value Examples

Description

This function inspects the output of the haplo_selection function in order to generate a logfile summarizing details of the analysis. The logfile can be output to a file (defaults to "Log.txt") or to optionally to standard output.

Usage

1
haplo_logfile(results, filename = "Log.txt", to_file = TRUE)

Arguments

results

A list containing a variable number of items among the following : Parameters, Kinship, Structure, All_markers, Filtered_markers, Clustered_markers, Selected_clusters, Selected_markers, Haplotypes. The precise output of the function will depend on the number of these elements given as input. The function will throw an error if any element other than those aforementioned is present in the input list.

filename

A character. The name of the file to which the logfile should be written. Ignored if to_file is FALSE.

to_file

A logical. Should the output be written to file? Defaults to TRUE, otherwise output is directed to standard output.

Details

The logfile is divided into 4 parts :

Value

NULL, invisibly. This function is called for its side effect of writing to file or to standard output.

Examples

1

malemay/HaplotypeMiner documentation built on May 28, 2019, 2:48 p.m.