Shasta commands
Shasta is most commonly used to run an assembly.
However, it provides additional utility functions
via command line option
--command
.
Following --command
, you specify a command name
which can be one of the following:
assemble
cleanupBinaryData
createBashCompletionScript
explore
filterReads
listCommands
listConfiguration
listConfigurations
saveBinaryData
shasta --command listCommands
The default command is
assemble
, so you don't need to use the
--command
option to run an assembly.
The rest of this page provides a brief description of the functionality provided by each of these commands.
Command assemble
This is the default command and is used to run an assembly. See here for more information.
Command cleanupBinaryData
This is used to unmount the filesystem in memory used to
hold Shasta binary data, mounted at the Data
directory under the assembly directory.
This frees the memory (in 4 Kb or 2 MB pages
depending on the setting of --memoryBacking
)
used to store data in the filesystem.
This also removes the Data
directory.
If a DataOnDisk
directory exists,
it creates a symbolic link to it, named Data
.
This makes it possible to use Shasta http server functionality
and the Python API even after the binary data are
no longer in memory, as long as they were saved
on disk using --command saveBinaryData
.
This command may require root privilege via sudo
,
depending on the setting of
--memoryBacking
.
See here for more information.
Command createBashCompletionScript
Running this command creates a Bash completion script
that provides completion of Shasta commands to facilitate typing.
The script is named shastaCompletion.sh
and can be invoked from a Bash shell as follows:
source shastaCompletion.sh
See here for more information.
Command explore
This command starts Shasta in a mode in which it behaves as an http server. You can use a browser to connect to it and visualize detailed information about your assembly. This requires the binary data for the assembly to be available. See here for more information.
Command filterReads
This command is experimental and is useful mostly for Shasta development.
It is intended to allow the user to perform read processing
separately from running an assembly.
Invoking filterReads
will run Shasta, loading the reads,
applying thresholds, and removing palindromes as is normally
done during assembly,
but the list of passing reads is written to a csv file and Shasta terminates once all reads are processed.
The Shasta command line arguments with a --Reads
prefix
therefore all apply to the filterReads
command.
This writes the names of all reads marked palindromic to
PalindromicReads.csv
and a list of all remaining reads longer than
--Reads.minReadLength
to PassingReads.csv
.
Command listCommands
This command prints an updated list of all valid commands known to the Shasta executable being invoked.
Command listConfiguration
A configuration is a built-in set of Shasta command line options
that can be selected by name.
To print details of a specific configuration, use:
shasta --command listConfiguration --config Name
For example
shasta --command listConfiguration --config Nanopore-Sep2020
To see a list of available configuration names, use
shasta --command listConfigurations
You can also create a configuration with command line options that you select and store it in a file. See here for more information.
Command listConfigurations
A configuration is a built-in set of Shasta command line options that can be selected by name. This command prints a list of the available configurations. See here for more information.
Command saveBinaryData
This is used to save Shasta binary data.
Binary data are stored in directory Data
in the assembly directory.
This command makes a copy on disk in Data
.
You will usually want to run
--command cleanupBinaryData
after this command completes.
This command may require root privilege via sudo
,
depending on the setting of
--memoryBacking
.
See here for more information.