ReadSparse {pgenlibr} | R Documentation |
If HasSparse() is true, returns a sparse representation for the (variant, allele) pair. If HasSparse() is false, the function fails.
Description
If HasSparse() is true, returns a sparse representation for the (variant, allele) pair. If HasSparse() is false, the function fails.
Usage
ReadSparse(pgen, variant_num, allele_num = 2L)
Arguments
pgen |
Object returned by NewPgen(). |
variant_num |
Variant index (1-based). |
allele_num |
Allele index; 1 corresponds to REF, 2 to the first ALT allele, 3 to the second ALT allele if it exists, etc. Optional, defaults to 2. |
Value
An object where "sample_nums" is an increasing sequence of positive integers listing which samples have the allele, and "dosages" is a vector listing the dosages (on a 0-2 scale) for those samples.
[Package pgenlibr version 0.5.3 Index]