salmonstats

Documentation

Overview

Package salmonstats contains implementations of core.Shift and core.ShiftIterator with associated methods to retrieve shifts from arbitrary salmon-stats/api instances.

Index

• func GetAllShifts(server types.Server, client *http.Client, quiet bool) (errs []error)
• func LoadFromFileIterator(server types.Server) (core.ShiftIterator, []error)

Functions

func GetAllShifts

func GetAllShifts(server types.Server, client *http.Client, quiet bool) (errs []error)

GetAllShifts downloads every shiftSalmonStats from the provided salmon-stats/api server and saves it to a gzipped jsonlines file.

func LoadFromFileIterator

func LoadFromFileIterator(server types.Server) (core.ShiftIterator, []error)

LoadFromFileIterator creates a core.ShiftIterator that iterates over the salmon-stats/api jsonlimnes in the file.