Tests: Checks the input data
In Families: Kinship Ties in (Virtual) Multi-Generation Populations

Tests

R Documentation

Checks the input data

Description

Tests existence of data file and identifies anomalies. If the data file d is null, the function checks whether dLH exists in the global environment. If it does, d=dLH. If not, the message "Object dLH is not provided and does not exist" is displayed and the processing stops. If some values in idego vector are missing (are NA) a message is displayed and the missing elements are removed.

Usage

Tests(idego, d = NULL)

Arguments

`idego`	ID
`d`	Name of database. If d is missing, the dataset dLH in the global environment (R workspace) is used. If no dLH in the global environment, the database dLH distributed with the Families package is used.

Details

The function Tests() is called in functions starting with ID, e.g. IDmother(). If the idego vector has values outside the acceptable range or missing values (NA), these outvalues are omitted and Tests gives a warning. The warning is not exported to the function calling Tests(). It is recommended to call Tests() before any other function call.