Main Content

reset

Reset BLAST database options to default values

Since R2024a

collapse all in page

Syntax

resetOpts = reset(blastplusOpts)
resetOpts = reset(blastplusOpts,propertyNames)

Description

resetOpts = reset(blastplusOpts) resets all properties of blastplusOpts, a BLAST+ options object, to their corresponding default values and returns a new options object with the default values restored.

example

resetOpts = reset(blastplusOpts,propertyNames) resets only the specified properties of blastplusOpts.

example

Examples

collapse all

This example uses:

Open Live Script

Download some paired-end sequencing data in the FASTA format using the accession run number SRR26273031.

databaseFasta = srafasterqdump("SRR26273031",FastaOutput=true)

Create a local nucleotide database using the downloaded FASTA file. Specify "SRR26273031_nucl_db" as the base name of the output database. When creating the database, the function also generates multiple index files with the same base name. The blastplus function uses these index files automatically when you search the database later in this example.

blastplusdatabase("nucleotide","SRR26273031.fasta","SRR26273031_nucl_db");

You can also specify additional database creation options using a MakeDatabaseOptions object. For instance, specify the title of the database.

dbopts = bioinfo.blastplus.MakeDatabaseOptions;
dbopts.Title = "SRR26273031_Nucleotide_DB"
dbopts = 
  MakeDatabaseOptions with properties:

   Default properties:
        ExtraCommand: ""
          IncludeAll: 0
           InputType: "fasta"
    ParseSequenceIDs: 0
             Version: "2.14.0"

   Modified properties:
               Title: "SRR26273031_Nucleotide_DB"

You can then use the options object to make the database.

blastplusdatabase("nucleotide","SRR26273031.fasta","SRR26273031_nucl_db",dbopts);

Alternatively, you can use specify options, such as the title of the database, by using name-value arguments. For example:

blastplusdatabase("nucleotide","SRR26273031.fasta","SRR26273031_nucl_db",Title="SRR26273031_Nucleotide_DB");

To reset the property values to their default values, use the reset function.

dopts2 = reset(dbopts)
dopts2 = 
  MakeDatabaseOptions with properties:

   Default properties:
        ExtraCommand: ""
          IncludeAll: 0
           InputType: "fasta"
    ParseSequenceIDs: 0
               Title: [1×0 string]
             Version: "2.14.0"

   Modified properties:
    No properties.

Search the database using the FASTA file queryFile.fasta containing two nucleotide query sequences. This file is provided with the toolbox. Use the blastn query program which lets you search nucleotide queries against a nucleotide database. Specify "search1" as the name of the output report file. By default, the report file format is the traditional BLAST pairwise format. This format presents each query-subject pair alignment in detail.

blastplus("blastn","queryFile.fasta","SRR26273031_nucl_db","search1");

Open the file to review the search results. The first query sequence returns no hits, while the second query sequence returns multiple hits. 

open search1;

You can also modify search options by creating a corresponding options object for the blastn query program. Use blastplusoptions or bioinfo.blastplus.*Options to create the options object. For instance, change the report format to an XML format.

bnopts = blastplusoptions("blastn"); % Or use bioinfo.blastplus.BLASTNOptions
bnopts.ReportFormat = "BLASTXML";
blastplus("blastn","queryFile.fasta","SRR26273031_nucl_db","search2_xml",bnopts);
open search2_xml;

Alternatively, you can set the value of a property of the options object, such as ReportFormat, using name-value argument syntax. For example:

blastplus("blastn","queryFile.fasta","SRR26273031_nucl_db","search2_xml",ReportFormat="BLASTXML");

You can use other query programs to search the database. For instance, use tblastx to search translated nucleotide queries against a translated nucleotide database. Both query sequences return hits for this search. Use the compact tabular format for the report. For details about the generated columns and other report formats, see ReportFormat.

blastplus("tblastx","queryFile.fasta","SRR26273031_nucl_db","search3_tab",ReportFormat="Tabular");
open search3_tab;

Delete the reports and downloaded FASTA file.

delete search1 search2_xml search3_tab SRR26273031.fasta

Input Arguments

collapse all

BLAST+ database options, specified as one of the following: bioinfo.blastplus.MakeDatabaseOptions, bioinfo.blastplus.BLASTNOptions, bioinfo.blastplus.BLASTPOptions, bioinfo.blastplus.BLASTXOptions, bioinfo.blastplus.TBLASTNOptions, or bioinfo.blastplus.TBLASTXOptions.

Property names of a BLAST+ options object to restore to their default values, specified as a character vector, string scalar, string vector, or cell array of character vectors.

Data Types: char | string | cell

Output Arguments

collapse all

BLAST+ database options, returned as one of the following: bioinfo.blastplus.MakeDatabaseOptions, bioinfo.blastplus.BLASTNOptions, bioinfo.blastplus.BLASTPOptions, bioinfo.blastplus.BLASTXOptions, bioinfo.blastplus.TBLASTNOptions, or bioinfo.blastplus.TBLASTXOptions.

Version History

Introduced in R2024a

See Also

| | | | | |