gndiff

Documentation

Index

• Variables
• type Differ
• type GNdiff
  • func New(cfg config.Config) GNdiff

Variables

var (
	// Version of gndiff
	Version = "v0.3.0"
	// Build timestamp
	Build = "n/a"
)

Types

type Differ

type Differ interface {
	// Compare takes a query
	// should be in a csv, tsv, or plain text format.
	Compare(
		query []record.Record,
		reference []record.Record,
	) (output.Output, error)
}

Differ contains method to match query and reference. `Query` contains scientific name-string to match, while `reference` contains scientific name-string to match against.

type GNdiff

type GNdiff interface {
	Differ
	GetVersion() gnvers.Version
}

GNdiff is an interface that enables comparison of two files that contain scientific names. Comparison tries to find matched names, and indicates type of match.

func New

func New(cfg config.Config) GNdiff