Skip to main content

blastx

Tags: fasta blast alignment protein translation bactopia-tool

Search against protein BLAST databases using translated nucleotide queries.

This Bactopia Tool uses BLASTX to query translated nucleotide sequences against protein databases for protein homology search.

Usage

Bactopia CLI:

bactopia --wf blastx \
--bactopia /path/to/your/bactopia/results

Nextflow:

nextflow run bactopia/bactopia/workflows/bactopia-tools/blastx/main.nf \
--bactopia /path/to/your/bactopia/results

Outputs

Expected Output Files

<BACTOPIA_DIR>
├── <SAMPLE_NAME>
│ └── tools
│ └── blastx-<TIMESTAMP>
│ ├── <SAMPLE_NAME>.blastx.tsv
│ └── logs
│ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ └── versions.yml
└── bactopia-runs
└── blastx-<TIMESTAMP>
├── merged-results
│ ├── blastx.tsv
│ └── logs
│ └── blastx-concat
│ ├── nf.command.{begin,err,log,out,run,sh,trace}
│ └── versions.yml
└── nf-reports
├── blastx-dag.dot
├── blastx-report.html
└── blastx-timeline.html

Per-Sample Results

FileDescription
*.blastx.tsvBLASTX alignment results in tabular format
*.blastx.htmlInteractive HTML report of BLASTX results

Merged Results

FileDescription
blastx.tsvMerged BLASTX results from all samples

Audit Trail

Below are files that can assist you in understanding which parameters and program versions were used.

Logs

Each process that is executed will have a folder named logs. In this folder are helpful files for you to review if the need ever arises.

ExtensionDescription
.beginAn empty file used to designate the process started
.errContains STDERR outputs from the process
.logContains both STDERR and STDOUT outputs from the process
.outContains STDOUT outputs from the process
.runThe script Nextflow uses to stage/unstage files and queue processes based on given profile
.shThe script executed by bash for the process
.traceThe Nextflow trace report for the process
versions.ymlA YAML formatted file with program versions

Nextflow Reports

These Nextflow reports provide great a great summary of your run. These can be used to optimize resource usage and estimate expected costs if using cloud platforms.

FilenameDescription
blastx-dag.dotThe Nextflow DAG visualization
blastx-report.htmlThe Nextflow Execution Report
blastx-timeline.htmlThe Nextflow Timeline Report
blastx-trace.txtThe Nextflow Trace report

Parameters

Required Parameters

Define where the pipeline should find input data and save output data.

ParameterTypeDefaultDescription
--bactopiastringThe path to bactopia results to use as inputs

BLASTX Parameters

ParameterTypeDefaultDescription
--blastx_querystringA fasta file containing the query sequences to BLAST against the database
--blastx_outfmtstringsseqid qseqid pident qlen slen length nident positive mismatch gapopen gaps qstart qend sstart send evalue bitscoreThe columns to include with -outfmt 6
--blastx_optsstringAdditional options to pass to BLASTN
--blastx_qcov_hsp_percinteger50Percent query coverage per hsp
--blastx_max_target_seqsinteger2000Maximum number of aligned sequences to keep
Filtering Parameters

Use these parameters to specify which samples to include or exclude.

ParameterTypeDefaultDescription
--includestringA text file containing sample names (one per line) to include from the analysis
--excludestringA text file containing sample names (one per line) to exclude from the analysis
Optional Parameters

These optional parameters can be useful in certain settings.

ParameterTypeDefaultDescription
--outdirstringbactopiaBase directory to write results to
Nextflow Profile Parameters

Parameters to fine-tune your Nextflow setup.

ParameterTypeDefaultDescription
--datasets_cachestring<HOME>/.bactopia/datasetsDirectory where downloaded datasets should be stored.
Helpful Parameters

Uncommonly used parameters that might be useful.

ParameterTypeDefaultDescription
--wfstringbactopiaSpecify which workflow or Bactopia Tool to execute
--list_wfsbooleanList the available workflows and Bactopia Tools to use with '--wf'
--help_allbooleanAn alias for --help --show_hidden_params
--versionbooleanDisplay version text.

Composition

This workflow uses the following subworkflows:

  • blastx - Translate nucleotide sequences and search protein database.

Citations

If you use this in your analysis, please cite the following.

Source

View source on GitHub