public class CheckIlluminaDirectory extends CommandLineProgram
Modifier and Type | Field | Description |
---|---|---|
File |
BASECALLS_DIR |
|
Set<IlluminaDataType> |
DATA_TYPES |
|
Boolean |
FAKE_FILES |
|
List<Integer> |
LANES |
|
Boolean |
LINK_LOCS |
|
String |
READ_STRUCTURE |
|
List<Integer> |
TILE_NUMBERS |
COMPRESSION_LEVEL, CREATE_INDEX, CREATE_MD5_FILE, GA4GH_CLIENT_SECRETS, MAX_RECORDS_IN_RAM, QUIET, REFERENCE_SEQUENCE, TMP_DIR, VALIDATION_STRINGENCY, VERBOSITY
Constructor | Description |
---|---|
CheckIlluminaDirectory() |
Modifier and Type | Method | Description |
---|---|---|
protected String[] |
customCommandLineValidation() |
Put any custom command-line validation in an override of this method.
|
protected int |
doWork() |
Do the work after command line has been parsed.
|
static void |
main(String[] argv) |
Required main method implementation.
|
getCommandLine, getCommandLineParser, getDefaultHeaders, getMetricsFile, getNestedOptions, getNestedOptionsForHelp, getStandardUsagePreamble, getVersion, instanceMain, instanceMainWithExit, parseArgs, setDefaultHeaders
@Option(doc="The basecalls output directory. ", shortName="B") public File BASECALLS_DIR
@Option(doc="The data types that should be checked for each tile/cycle. If no values are provided then the data types checked are those required by IlluminaBaseCallsToSam (which is a superset of those used in ExtractIlluminaBarcodes). These data types vary slightly depending on whether or not the run is barcoded so READ_STRUCTURE should be the same as that which will be passed to IlluminaBasecallsToSam. If this option is left unspecified then both ExtractIlluminaBarcodes and IlluminaBaseCallsToSam should complete successfully UNLESS the individual records of the files themselves are spurious.", shortName="DT", optional=true) public final Set<IlluminaDataType> DATA_TYPES
@Option(doc="A description of the logical structure of clusters in an Illumina Run, i.e. a description of the structure IlluminaBasecallsToSam assumes the data to be in. It should consist of integer/character pairs describing the number of cycles and the type of those cycles (B for Sample Barcode, M for molecular barcode, T for Template, and S for skip). E.g. If the input data consists of 80 base clusters and we provide a read structure of \"28T8M8B8S28T\" then the sequence may be split up into four reads:\n* read one with 28 cycles (bases) of template\n* read two with 8 cycles (bases) of molecular barcode (ex. unique molecular barcode)\n* read three with 8 cycles (bases) of sample barcode\n* 8 cycles (bases) skipped.\n* read four with 28 cycles (bases) of template\nThe skipped cycles would NOT be included in an output SAM/BAM file or in read groups therein. Note: If you want to check whether or not a future IlluminaBasecallsToSam or ExtractIlluminaBarcodes run will fail then be sure to use the exact same READ_STRUCTURE that you would pass to these programs for this run.", shortName="RS") public String READ_STRUCTURE
@Option(doc="The number of the lane(s) to check. ", shortName="L", minElements=1) public List<Integer> LANES
@Option(doc="The number(s) of the tile(s) to check. ", shortName="T", optional=true) public List<Integer> TILE_NUMBERS
@Option(doc="A flag to determine whether or not to create fake versions of the missing files.", shortName="F", optional=true) public Boolean FAKE_FILES
public static void main(String[] argv)
protected int doWork()
CommandLineProgram
doWork
in class CommandLineProgram
protected String[] customCommandLineValidation()
CommandLineProgram
customCommandLineValidation
in class CommandLineProgram