Main Content

bioinfo.pipeline.block.CuffCompare

Bioinformatics pipeline block to compare assembled transcripts

Since R2023a

expand all in page
  • cuffcompare block icon

Description

A CuffCompare block enables you to compare assembled transcripts across multiple experiments.

The block requires the Cufflinks Support Package for the Bioinformatics Toolbox™. If the support package is not installed, then a download link is provided. For details, see Bioinformatics Toolbox Software Support Packages.

Creation

Syntax

b = bioinfo.pipeline.block.CuffCompare
b = bioinfo.pipeline.block.CuffCompare(options)
b = bioinfo.pipeline.block.CuffCompare(Name=Value)

Description

b = bioinfo.pipeline.block.CuffCompare creates a CuffCompare block.

example

b = bioinfo.pipeline.block.CuffCompare(options) also specifies additional options.

b = bioinfo.pipeline.block.CuffCompare(Name=Value) specifies additional options as the property names and values of a CuffCompareOptions object. This object is set as the value of the Options property of the block.

Input Arguments

expand all

CuffCompare options, specified as a CuffCompareOptions object, string, or character vector.

If you are specifying a string or character vector, it must be in the cuffcompare native syntax (prefixed by one or two dashes) [1].

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Note

The following list of arguments is a partial list. For the complete list, refer to the properties of CuffCompareOptions object.

Prefix for consensus transcript names in the output combined.gtf file, specified as a string or character vector. This option must be a string or character vector with a non-zero length.

Example: "consensusTs"

Data Types: char | string

Flag to ignore intron-redundant transfrags if they have the same 5' end but different 3' ends, specified as true or false.

Example: true

Data Types: logical

Properties

expand all

Function to handle errors from the run method of the block, specified as a function handle. The handle specifies the function to call if the run method encounters an error within a pipeline. For the pipeline to continue after a block fails, ErrorHandler must return a structure that is compatible with the output ports of the block. The error handling function is called with the following two inputs:

  • Structure with these fields:

    FieldDescription
    identifierIdentifier of the error that occurred
    messageText of the error message
    indexLinear index indicating which block process failed in the parallel run. By default, the index is 1 because there is only one run per block. For details on how block inputs can be split across different dimensions for multiple run calls, see Bioinformatics Pipeline SplitDimension.

  • Input structure passed to the run method when it fails

Data Types: function_handle

This property is read-only.

Input ports of the block, specified as a structure. The field names of the structure are the names of the block input ports, and the field values are bioinfo.pipeline.Input objects. These objects describe the input port behaviors. The input port names are the expected field names of the input structure that you pass to the block run method.

The CuffCompare block Inputs structure has the following field:

  • GenomicAnnotationFiles — Names of GTF files. Each GTF file corresponds to a sample produced by the Cufflinks block. This input is a required input that must be satisfied. The default value is a bioinfo.pipeline.datatypes.Unset object, which means that the input value is not set yet.

Data Types: struct

This property is read-only.

Output ports of the block, specified as a structure. The field names of the structure are the names of the block output ports, and the field values are bioinfo.pipeline.Output objects. These objects describe the output port behaviors. The field names of the output structure returned by the block run method are the same as the output port names.

The CuffCompare block Outputs structure has the following fields:

  • StatsFile — Name of the text file containing statistics related to the accuracy of the transcripts in each sample.

  • CombinedGTFFile — Name of the file containing the union of all transfrags in each sample.

  • LociFile — Name of file with all processed loci across all transcripts.

  • TrackingFile — Name of the file containing transcripts with identical coordinates, introns, and strands.

Tip

To see the actual location of these files, first get the results of the block. Then use the unwrap method as shown in this example.

Data Types: struct

CuffCompare options, specified as a CuffCompareOptions object. The default value is a default CuffCompareOptions object.

Object Functions

compilePerform block-specific additional checks and validations
copyCopy array of handle objects
emptyInputsCreate input structure for use with run method
evalEvaluate block object
runRun block object

Examples

collapse all

Compare assembled transcripts using the provided GTF files which were pregenerated by cufflinks.

import bioinfo.pipeline.block.*
import bioinfo.pipeline.Pipeline

gtfFiles = {which("Myco_1_1.transcripts.gtf"),which("Myco_2_1.transcripts.gtf")};
FC = FileChooser(gtfFiles);
CC = CuffCompare;

P = Pipeline;
addBlock(P,[FC,CC]);
connect(P,FC,CC,["Files","GenomicAnnotationFiles"]);

run(P);
R = results(P,CC)
R = 

  struct with fields:

          StatsFile: [1×1 bioinfo.pipeline.datatypes.File]
    CombinedGTFFile: [1×1 bioinfo.pipeline.datatypes.File]
           LociFile: [1×1 bioinfo.pipeline.datatypes.File]
       TrackingFile: [1×1 bioinfo.pipeline.datatypes.File]

Call unwrap on each field of the result structure R to see the location of each output file. For example, to see the location of StatsFile, enter the following.

unwrap(R.StatsFile)
ans = 

    "C:\PipelineResults\CuffCompare_1\1\cuffcmp.stats"

References

[1] Trapnell, Cole, Brian A Williams, Geo Pertea, Ali Mortazavi, Gordon Kwan, Marijke J van Baren, Steven L Salzberg, Barbara J Wold, and Lior Pachter. “Transcript Assembly and Quantification by RNA-Seq Reveals Unannotated Transcripts and Isoform Switching during Cell Differentiation.” Nature Biotechnology 28, no. 5 (May 2010): 511–15.

Version History

Introduced in R2023a

See Also

| |