Package picard.sam
Class AddCommentsToBam
- java.lang.Object
-
- picard.cmdline.CommandLineProgram
-
- picard.sam.AddCommentsToBam
-
@DocumentedFeature public class AddCommentsToBam extends CommandLineProgram
A tool to add comments to a BAM file header. Effectively copies the BAM file except for the addition of the @CO records in the header. This tool does not support SAM files. A block copying method is used to ensure efficient transfer to the output file.
-
-
Field Summary
Fields Modifier and Type Field Description List<String>
COMMENT
File
INPUT
File
OUTPUT
-
Fields inherited from class picard.cmdline.CommandLineProgram
COMPRESSION_LEVEL, CREATE_INDEX, CREATE_MD5_FILE, GA4GH_CLIENT_SECRETS, MAX_RECORDS_IN_RAM, QUIET, REFERENCE_SEQUENCE, referenceSequence, specialArgumentsCollection, TMP_DIR, USE_JDK_DEFLATER, USE_JDK_INFLATER, VALIDATION_STRINGENCY, VERBOSITY
-
-
Constructor Summary
Constructors Constructor Description AddCommentsToBam()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected int
doWork()
Do the work after command line has been parsed.static void
main(String[] args)
-
Methods inherited from class picard.cmdline.CommandLineProgram
customCommandLineValidation, getCommandLine, getCommandLineParser, getDefaultHeaders, getFaqLink, getMetricsFile, getStandardUsagePreamble, getStandardUsagePreamble, getVersion, hasWebDocumentation, instanceMain, instanceMainWithExit, makeReferenceArgumentCollection, parseArgs, requiresReference, setDefaultHeaders, useLegacyParser
-
-
-
-
Method Detail
-
main
public static void main(String[] args)
-
doWork
protected int doWork()
Description copied from class:CommandLineProgram
Do the work after command line has been parsed. RuntimeException may be thrown by this method, and are reported appropriately.- Specified by:
doWork
in classCommandLineProgram
- Returns:
- program exit status.
-
-