NAME

Sketch interface module

SYNOPSIS

An interface module for Sketches, e.g., Mash

use strict;
use warnings;
use Bio::Sketch::Mash;

# Produce a sketch file file.fastq.gz.msh
system("mash sketch file.fastq.gz");
# Read the sketch
my $sketch = Bio::Sketch::Mash->new("file.fastq.gz.msh");
$sketch->writeJson("file.fastq.gz.json");

Bio::Sketch->new("file.msh", \%options);

Create a new Sketch instance. One object per file.

  Arguments: Sketch filename
	           Hash of options
  Returns:   Sketch object

$sketch->sketch("file.fastq.gz");

Sketch a raw reads or assembly file

Arguments: Filename
Returns:   1 for success or 0 for failure

$sketch->dist($other);

Find the distance between two sketches

Arguments: Bio::Sketch object
Returns:   Distance in a float

$sketch->paste([$other, $other2...]);

Merge two sketches

Arguments: List of Bio::Sketch objects
Returns:   Bio::Sketch object of merged sketches