hail.vds.store_ref_block_max_length

hail.vds.store_ref_block_max_length(vds_path)[source]

Patches an existing VDS file to store the max reference block length for faster interval filters.

This method permits vds.filter_intervals() to remove reference data not overlapping a target interval.

This method is able to patch an existing VDS file in-place, without copying all the data. However, if significant downstream interval filtering is anticipated, it may be advantageous to run vds.truncate_reference_blocks() to truncate long reference blocks and make interval filters even faster. However, truncation requires rewriting the entire VDS.

Examples

>>> hl.vds.store_ref_block_max_length('gs://path/to/my.vds')  
Parameters:

vds_path (str)