Function bed_reader::sample_file

source ·
pub fn sample_file<AnyPath0>(path: AnyPath0) -> Result<PathBuf, BedErrorPlus>where
    AnyPath0: AsRef<Path>,
Expand description

Returns the local path to a sample file. If necessary, the file will be downloaded.

A SHA256 hash is used to verify that the file is correct. The file will be in a directory determined by environment variable BED_READER_DATA_DIR. If that environment variable is not set, a cache folder, appropriate to the OS, will be used.