read_blacklist_id: read_blacklist_id

read_blacklist_idR Documentation

read_blacklist_id

Description

Read a file or object with blacklisted individuals. Used internally in radiator and might be of interest for users.

Usage

read_blacklist_id(blacklist.id = NULL, verbose = TRUE)

Arguments

blacklist.id

(optional, path or object) A blacklist file in the working directory or object in the global environment. The data frame as 1 column (named INDIVIDUALS) and is filled with the individual IDs The ids are cleaned with clean_ind_names for separators, only - are tolerated. Duplicates are removed automatically. Default: blacklist.id = NULL.

verbose

(optional, logical) When verbose = TRUE the function is a little more chatty during execution. Default: verbose = TRUE.

Value

A tibble with column INDIVIDUALS.

Examples

## Not run: 
bl <- radiator::read_blacklist_id("blacklist.tsv")

## End(Not run)

thierrygosselin/radiator documentation built on May 5, 2024, 5:12 a.m.