readFast5Log {IONiseR} | R Documentation

## Read the log entry from a single fast5 file

### Description

Basecalling procedures performed on fast5 files generally leave a log file entry recording how far through the pipeline the file proceeded. This function will extract this information as a single string. It can be printed in a more readable format using the `cat` function.

### Usage

    readFast5Log(file)

### Arguments

`file` | Character vector of fast5 file to be read.

### Value

Character vector containing the log information. `NULL` if no log is found.

### Examples

    fast5file <- system.file('extdata', 'example.fast5', package = "IONiseR")
    log <- readFast5Log(fast5file)
    cat(log)

[Package IONiseR version 2.18.0 Index]