tsv_to_kinpair: Reads '.tsv' and converts to 'KinPairData' object

In kindisperse: Simulate and Estimate Close-Kin Dispersal Kernels

Description

This function is part of suite of functions handling file import/export for kinship dispersal objects.

.csv & .tsv reading functions at minimum require the .delim file to contain a column titled 'distance' containing distances between kin pairs. It can optionally contain a column of kinship values 'kinship' as well as a column of lifestage values 'lifestage'. If the file contains more than one value in the kinship or lifestage columns (e.g. bot 'FS' and 'HS') - the corresponding function parameter must be set to pick a corresponding subset of dispersed pairs. where parameters are set in the absence of file columns, these values are assigned to the returned KinPairData object.

Usage

tsv_to_kinpair(file, kinship = NULL, lifestage = NULL, ...)

Arguments

file	The file path to read from
kinship	character. kin category to assign or extract from data. one of PO, FS, HS, AV, GG, HAV, GGG, 1C, 1C1, 2C, GAV, HGAV, H1C , H1C1 or H2C
lifestage	character. lifestage to assign or extract from data. one of 'unknown', 'immature' or 'ovipositional'.
...	additional arguments to pass to read_tsv

Value

Returns object of class KinPairData

See Also

Other import_functions: csv_to_kinpair(), df_to_kinpair(), read_kindata(), vector_to_kinpair()

kindisperse documentation built on July 28, 2021, 5:09 p.m.