iqtl_meta: Associate metadata with an IQTL file

Description Usage Arguments Details Value Examples

View source: R/iqtl_fun.R

Description

Add metadata along an imported IQTL data file.

Usage

1
iqtl_meta(file, meta_data = list(conc = NA), exclude = NULL, ...)

Arguments

file

Path to the file.

meta_data

List to construct a metadata data frame from.

exclude

A character vector with lane_ids to remove from the result.

...

Other arguments passed to iqtl_read.

Details

This function calls iqtl_read with its default arguments for col_group ("lane"), .id ("id") and .sep ("_").

If meta_data contains an entry named "lane_id", its entries are used to join the imported data with the metadata annotation. If no such entry exists, the data is assumed to be parallel to the result of iqtl_read. (More specifically, to the levels of .$lane_id.)

Internally, meta_data is converted to a data.frame.

Value

A data frame of class data.table.

Examples

1
2
assay_file <- system.file("extdata", "gel_01.txt", package = "summerrband")
assay_data <- iqtl_meta(assay_file, list(conc = c(2^seq(10, 0), 0)))

benjbuch/summerrband documentation built on Dec. 19, 2021, 8:43 a.m.