Package org.snpsift
Class SnpSiftCmdGwasCatalog
java.lang.Object
org.snpsift.SnpSift
org.snpsift.SnpSiftCmdGwasCatalog
- All Implemented Interfaces:
org.snpeff.snpEffect.commandLine.CommandLine,org.snpeff.snpEffect.VcfAnnotator
Annotate a VCF file using GWAS catalog database
Loads GWAS catalog in memory, thus it makes no assumption about order.
- Author:
- pablocingolani
-
Field Summary
FieldsFields inherited from class org.snpsift.SnpSift
args, BUILD, command, config, configFile, dataDir, dbFileName, dbTabix, dbType, debug, download, EMPTY_ARGS, errCount, genomeVersion, help, log, needsConfig, needsDb, needsGenome, numWorkers, output, quiet, REVISION, saveOutput, shiftArgs, SHOW_EVERY_VCFLINES, showVcfHeader, showVersion, SOFTWARE_NAME, suppressOutput, vcfHeaderAddProgramVersion, vcfHeaderProcessed, vcfInputFile, verbose, VERSION, VERSION_MAJOR, VERSION_NO_NAME, VERSION_SHORT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanannotate(org.snpeff.vcf.VcfEntry vcfEntry) booleanannotateFinish(org.snpeff.fileIterator.VcfFileIterator vcfFile) booleanannotateInit(org.snpeff.fileIterator.VcfFileIterator vcfFile) protected List<org.snpeff.vcf.VcfHeaderEntry> headers()Headers to addvoidinit()Initialize default valuesvoidParse command line argumentsvoidreadDb()Read databasebooleanrun()Annotate entriesList<org.snpeff.vcf.VcfEntry> run(boolean saveResults) voidShow usage messageMethods inherited from class org.snpsift.SnpSift
addHeaders, cmd, commandLineStr, databaseDownload, databaseFind, error, getArgs, getConfig, getConfigFile, getOutput, isOpt, loadConfig, main, openVcfInputFile, processVcfHeader, setCommand, setCommand, setConfig, setConfigFile, setDbFileName, setDebug, setQuiet, setSaveOutput, setShowVcfHeader, setShowVersion, setSuppressOutput, setVcfHeaderAddProgramVersion, setVerbose, showCmd, showVersion, unSanitize, usageGenericAndDb
-
Field Details
-
SHOW
public static final int SHOW- See Also:
-
SHOW_LINES
public static final int SHOW_LINES- See Also:
-
GWAS_CATALOG
- See Also:
-
CONFIG_GWAS_DB_NAME
- See Also:
-
-
Constructor Details
-
SnpSiftCmdGwasCatalog
public SnpSiftCmdGwasCatalog() -
SnpSiftCmdGwasCatalog
-
-
Method Details
-
annotate
public boolean annotate(org.snpeff.vcf.VcfEntry vcfEntry) -
annotateFinish
public boolean annotateFinish(org.snpeff.fileIterator.VcfFileIterator vcfFile) - Specified by:
annotateFinishin interfaceorg.snpeff.snpEffect.VcfAnnotator- Overrides:
annotateFinishin classSnpSift
-
annotateInit
public boolean annotateInit(org.snpeff.fileIterator.VcfFileIterator vcfFile) - Specified by:
annotateInitin interfaceorg.snpeff.snpEffect.VcfAnnotator- Overrides:
annotateInitin classSnpSift
-
headers
Description copied from class:SnpSiftHeaders to add -
init
public void init()Initialize default values -
parseArgs
Parse command line arguments -
readDb
public void readDb()Read database -
run
public boolean run()Annotate entries -
run
-
usage
Show usage message
-