numAvailableRecords: Probe the number of available records

In gwsem: Genome-Wide Structural Equation Modeling

Description

\lifecycle

maturing It can be useful to know the number of SNPs in advance of running a set of analyses.

Usage

numAvailableRecords(snpData)

Arguments

snpData

a pathway to a file containing GWAS data. The data can be in a variety of forms, such as standard PLINK format (bed/bim/fam), PLINK2 format (pgen/pvar/psam), Oxford format (bgen/sample), or CSV format (csv format in much slower due to the lack of compression for non-binary files).

Value

Returns a vector of record counts. The vector is named by the containing file path.

Examples

dir <- system.file("extdata", package = "gwsem")
numAvailableRecords(file.path(dir,"example.bgen"))

gwsem documentation built on Jan. 18, 2022, 1:09 a.m.