sparkhail (version 0.1.1)

hail_read_matrix: Read a MatrixTable

Description

Read and create a MatrixTable object, it is necessary to convert the data in dataframe using hail_dataframe.

Usage

hail_read_matrix(hl, path)

Arguments

hl

A hail context object. Create one using hail_context().

path

A string with the path to MatrixTable folder

Value

hail_matrix_table

Details

A hail MatrixTable is a standard data structure in hail framework. A MatrixTable consists of four components:

  • a two-dimensional matrix of entry fields where each entry is indexed by row key(s) and column key(s)

  • a corresponding rows table that stores all of the row fields that are constant for every column in the dataset

  • a corresponding columns table that stores all of the column fields that are constant for every row in the dataset

  • a set of global fields that are constant for every entry in the dataset

You can see the MatrixTable structure using hail_describe.