Chum::Result::Result - A result container from any analysis.
Stores output information from an analysis. Stores information about the type of analysis run (whether it was the canonical sequence or a variant sequence, including the used sequence and the filename of the output results.
Example:
my $result = new Chum::Result::Result('type' => 'CANONICAL', 'sequence' => $stack_object->reference_sequence, 'results_file' => "foo");
Usually many Chum::Result::Result objects are stored in a Chum::Result::ResultSet object
Stephen Montgomery (smontgom@bcsgc.bc.ca)
Usage : $result->type;
the type of analysis result can either be CANONICAL or VARIANT. CANONICAL results
are from reference sequences derived from a genome. VARIANT results are from
sequences containing a variant as derived artificially or from a population genetics-based source.
Returns : string
Args : optional string argument can be passed to set the value. i.e. $result->type("CANONICAL");
Usage : $result->sequence;
the Chum::VariantSequence sequence object used to run the analysis
Returns : Chum::VariantSequence object
Args : optional Chum::VariantSequence argument can be passed to set the value. i.e. $result->sequence($variant_sequence_object);
Usage : $result->results_file;
the location of the raw output from this analysis as a filename
Returns : string
Args : optional string argument can be passed to set the value. i.e. $result->results_file("/tmp/results.out");
Usage : $result->named_supplementary_result_files;
the location of the supplementary output files from this analysis as a filenames
Returns : hashref
Args : optional hashref argument can be passed to set the value. i.e. $result->named_supplementary_result_files(\%other_output_files);
Usage : $result->results_object;
results object (can be anything to store any results from an embedded analysis). this is used for analyses that
are not run externally of Chum.
Returns : object
Args : optional object argument can be passed to set the value. i.e. $result->results_object($features);