read_gcta_hsq: Read GCTA REML variance components table

In OchoaLab/genbin: R wrappers for binaries in genetics

Read GCTA REML variance components table

Description

Parses the output generated by GCTA with option --reml (heritability estimation). Returned table has column names standardized for convenience. Validated with GCTA version 1.93.2 beta.

Usage

read_gcta_hsq(file, ext = "hsq", verbose = TRUE)

Arguments

file	The file path to read, possibly missing the extension.
ext	The expected file extension. Set to NA to prevent adding any extension to file. The default extension "hsq" agrees with the output of gcta_reml().
verbose	If TRUE (default) function reports the path of the file being loaded (after autocompleting the extensions).

Value

A list containing these named elements:

• herit: the estimated heritability.

• se: the standard error of the heritability estimate.

• data: the full table of variance component estimates and other miscelaneous info.

See Also

gcta_reml() wrapper for executing GCTA REML and reading the results.

Examples

## Not run: 
obj <- read_gcta_hsq( file )
obj$herit

## End(Not run)

OchoaLab/genbin documentation built on Nov. 14, 2024, 7:33 p.m.