bioinfo.pipeline.datatype.File

File object for bioinformatics pipeline

Since R2023a

Description

A bioinfo.pipeline.datatype.File object represents a file or an array of files that you can use in a bioinformatics pipeline. This object ensures that the file paths can be shared between blocks in a pipeline.

Tip

For most workflows, use a FileChooser block to select input files for your pipeline. You might create this File object by itself when you are implementing your own block subclasses and want to share the files between blocks in your pipeline.

Creation

Syntax

fileObj = bioinfo.pipeline.blocks.File(fileName)

Description

fileObj = bioinfo.pipeline.blocks.File(fileName) creates a File object that represents the specified file fileName.

Input Arguments

fileName — File name

string | character vector | ...

File name, specified as a string, character vector, string array, or cell array of character vectors representing multiple file names.

Specify a file name or path and file name if the file is not in the current directory. This object does not use the MATLAB^® search path.

Data Types: char | string | cell

Object Functions

unwrap

Display full file path and name

Examples

Create File Object for Bioinformatics Pipeline

Create a File object.

file1 = which("SRR6008575_10k_1.fq");
fObj = bioinfo.pipeline.datatype.File(file1)

fObj = 
  File with no properties.

Use unwrap to display the full file path.

unwrap(fObj)

Version History

Introduced in R2023a