Skip to contents

[Stable]

Usage

read_qview_template(path, verbose = TRUE, call = rlang::caller_env())

Arguments

path

Path to the template file (csv).

verbose

Logical. Print a short summary after parsing. Default TRUE.

call

The execution environment of the calling function. Used for error reporting; experts only.

Value

A tibble::tibble() with one row per well and columns well (character, e.g. "A1"), plate_row (character, "A"..), plate_col (integer), sample_id (character), group_type (character), dilution (numeric).

Details

Parses the plate-template CSV that Q-View imports for sample assignment. The file uses a multi-section layout: an NxM cell in the top-left declares the plate dimensions, followed by sections labelled Group Name, Group Type, and Dilution Factor. Each section is one row per plate row and one column per plate column.

All three required sections must have each declared row and column exactly once. Dimensions must fit the source and use at most 26 single- letter rows; this does not extend binary report support beyond 96 wells. Nonblank dilution values must be positive finite numbers. Blank sample and dilution cells remain missing. Identifiers are decoded as text, preserving leading zeroes, quoted punctuation and non-dilution suffixes. Text uses the UTF-8-then-Latin-1 fallback described in read_qview_report(). The template is an independent assignment source; binary report extraction does not recover every original template field.

See also

Other qview-reader: read_qview(), read_qview_report()

Examples

path <- system.file("extdata", "example-template.csv",
                    package = "qviewparsR")
layout <- read_qview_template(path)
#> ✔ Parsed Q-View template: 96 wells, 19 unique samples from
#>   /home/runner/work/_temp/Library/qviewparsR/extdata/example-template.csv.
head(layout)
#> # A tibble: 6 × 6
#>   well  plate_row plate_col sample_id group_type dilution
#>   <chr> <chr>         <int> <chr>     <chr>         <dbl>
#> 1 A1    A                 1 Cal 1     calibrator       NA
#> 2 B1    B                 1 Cal 2     calibrator       NA
#> 3 C1    C                 1 Cal 3     calibrator       NA
#> 4 D1    D                 1 Cal 4     calibrator       NA
#> 5 E1    E                 1 Cal 5     calibrator       NA
#> 6 F1    F                 1 Cal 6     calibrator       NA