renameBlock

Rename block in block library

Since R2023a

collapse all in page

Syntax

renameBlock(lib,currentNames,newNames)

Description

renameBlock(lib,currentNames,newNames) changes the current names of the blocks to newNames.

example

Examples

collapse all

Open Live Script

Import the pipeline, block, and library objects needed for the example.

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

Create a library and add it to the list of available libraries.

mylib = Library;
mylib.Name = "customLib";
addLibrary(mylib);

Create a FeatureCount block and a FileChooser block for a FASTQ file, that is provided with the toolbox and add to the library.

fcBlock = FeatureCount;
fastqfile = FileChooser(which("SRR005164_1_50.fastq"));

Add the blocks to the library. Name the blocks as "featurecount" and "fastqfile", respectively.

addBlock(mylib,fcBlock,"featurecount");
addBlock(mylib,fastqfile,"fastqfile");

Find a block by its name from the library.

b1 = findBlock(mylib,"featurecount")
b1 = 
  FeatureCount with properties:

         Options: [1×1 bioinfo.pipeline.options.FeatureCountOptions]
          Inputs: [1×1 struct]
         Outputs: [1×1 struct]
    ErrorHandler: []

You can also search for multiple blocks.

bArray = findBlock(mylib,["fastqfile","featurecount"]);
length(bArray)
ans = 
2

Rename the "featurecount" block to "fcBlock".

renameBlock(mylib,"featurecount","fcBlock");
mylib.BlockNames
ans = 2×1 string
    "fastqfile"
    "fcBlock"

Input Arguments

collapse all

Block library, specified as a bioinfo.pipeline.library.Library object.

Current names of blocks, specified as a character vector, string scalar, string vector, or cell array of character vectors.

New names of blocks, specified as a character vector, string scalar, string vector, or cell array of character vectors. The new names must be valid variable names and must be unique within the library.

Version History

Introduced in R2023a

See Also

| | | |