Skip to contents

HSP format

Source: R/hsp.R
hsp.Rd

Half-sib pairs are counted between samples grouped by birth year and sampled location.

Usage

as_hsp(samples)

write_hsp(x, path = "hsp.txt")

read_hsp(path)

Arguments

samples

A sample_family data.frame of tekka() result.

x

An outcome of as_hsp()

path

A file name or connection to write to

Value

A data.frame with "hsp" class and six columns:

  • cohort_i, cohort_j: birth year of samples

  • location_i, location_j: of sampling

  • comps: the number of possible comparisons between group i and j

  • hsps: the number of half-sib pairs between group i and j

Details

as_hsp() converts a result data frame to HSP format.

write_hsp() writes a HSP data.frame to a file.