gds::pgenstream Class Reference

#include <pgenstream.h>

Inheritance diagram for gds::pgenstream:

Public Member Functions
	pgenstream ()
	pgenstream (const Param &param)
	~pgenstream ()
void	setRegions (const vector< string > &regions) override
int	n_samples () override
vector< string >	getSampleNames () override
string	getStreamType () override
GenomicRanges	getChromRanges () override
bool	getNextChunk (DataChunk< arma::mat > &chunk, const bool &useFilter=true) override
bool	getNextChunk (DataChunk< arma::sp_mat > &chunk, const bool &useFilter=true) override
bool	getNextChunk (DataChunk< Eigen::MatrixXd > &chunk, const bool &useFilter=true) override
bool	getNextChunk (DataChunk< Eigen::SparseMatrix< double > > &chunk, const bool &useFilter=true) override
bool	getNextChunk (DataChunk< Rcpp::NumericMatrix > &chunk, const bool &useFilter=true) override
bool	getNextChunk (DataChunk< vector< double > > &chunk, const bool &useFilter=true) override
Public Member Functions inherited from gds::GenomicDataStream
	GenomicDataStream ()
	GenomicDataStream (const Param &param)
virtual	~GenomicDataStream ()
double	getMinVariance ()
double	getMAF () const
void	setMinVariance (const double &value)
void	setChunkSize (const int &chunkSize)
Param	getParam () const

Additional Inherited Members
Protected Attributes inherited from gds::GenomicDataStream
Param	param

Detailed Description

pgenstream reads a PGEN into an matrix in chunks, storing variants in columns. Applies filtering for specified samples and genome region.

Constructor & Destructor Documentation

pgenstream() [1/2]

gds::pgenstream::pgenstream ( )

inline

pgenstream() [2/2]

gds::pgenstream::pgenstream ( const Param & param )

inline

constructor

~pgenstream()

gds::pgenstream::~pgenstream ( )

inline

destructor

Member Function Documentation

getChromRanges()

GenomicRanges gds::pgenstream::getChromRanges ( )

inlineoverridevirtual

Get maximum position for each chrom

Implements gds::GenomicDataStream.

getNextChunk() [1/6]

bool gds::pgenstream::getNextChunk ( DataChunk< arma::mat > & chunk, const bool & useFilter = true )

inlineoverridevirtual

Get next chunk of features as arma::mat

Implements gds::GenomicDataStream.

getNextChunk() [2/6]

bool gds::pgenstream::getNextChunk ( DataChunk< arma::sp_mat > & chunk, const bool & useFilter = true )

inlineoverridevirtual

Get next chunk of features as arma::sp_mat

Implements gds::GenomicDataStream.

getNextChunk() [3/6]

bool gds::pgenstream::getNextChunk ( DataChunk< Eigen::MatrixXd > & chunk, const bool & useFilter = true )

inlineoverridevirtual

Get next chunk of features as Eigen::MatrixXd

Implements gds::GenomicDataStream.

getNextChunk() [4/6]

bool gds::pgenstream::getNextChunk ( DataChunk< Eigen::SparseMatrix< double > > & chunk, const bool & useFilter = true )

inlineoverridevirtual

Get next chunk of features as SparseMatrix<double>

Implements gds::GenomicDataStream.

getNextChunk() [5/6]

bool gds::pgenstream::getNextChunk ( DataChunk< Rcpp::NumericMatrix > & chunk, const bool & useFilter = true )

inlineoverridevirtual

Get next chunk of features as Rcpp::NumericMatrix

Implements gds::GenomicDataStream.

getNextChunk() [6/6]

bool gds::pgenstream::getNextChunk ( DataChunk< vector< double > > & chunk, const bool & useFilter = true )

inlineoverridevirtual

Get next chunk of features as vector<double>

Implements gds::GenomicDataStream.

getSampleNames()

vector< string > gds::pgenstream::getSampleNames ( )

inlineoverridevirtual

Get vector of sample names in order that the genotypes are extracted

Implements gds::GenomicDataStream.

getStreamType()

string gds::pgenstream::getStreamType ( )

inlineoverridevirtual

get FileType of param.file

Implements gds::GenomicDataStream.

n_samples()

int gds::pgenstream::n_samples ( )

inlineoverridevirtual

Get number of columns in data matrix

Implements gds::GenomicDataStream.

setRegions()

void gds::pgenstream::setRegions ( const vector< string > & regions )

inlineoverridevirtual

setter

Implements gds::GenomicDataStream.

---

The documentation for this class was generated from the following file:

• inst/include/pgenstream.h