Tagged with #documentation
0 documentation articles | 1 announcement | 10 forum discussions

No articles to display.

Created 2012-11-16 21:52:10 | Updated | Tags: documentation community

Comments (0)

Hello GATK users,

As you know, we have been trying for the past few months to beef up support and improve documentation. This is a long game and although we'd like to think we've made some progress, there still remains a lot to be done.

One thing we're doing right now is developing teaching materials for the upcoming workshop. Even though that will only serve a portion of our user community directly, the materials will be a useful addition to the online documentation. We've also got some new documents in preparation that should help with parallelization options, as well as some frequently asked questions on a range of subjects, illustrations to clarify workflows, and a lot of updates and link fixes for the older doc articles.

All of this takes time to develop, and unfortunately, responding to questions on the forum takes time away from that.

So we're appealing to everyone of you to help us by helping others. There's a whole subset of "beginner" questions that any intermediate user could easily answer. It would be a big help if you folks could jump in and answer those questions for us whenever you can. Some of you are already doing it, and we're really thankful, because it takes some of our support burden away and frees up time for us to work on the materials that can benefit many people at once. So we'd love to see more people help in this way, and to be able to move more questions to the "Ask the Community" section (which currently houses mostly the "weird datasets" questions that we honestly don't know how to answer).

We'd be happy to consider an incentive system, by the way. We can't really offer money or anything like that, but if there's any intangible form of reward that would motivate you (leaderboards? gold stars? "expert support" coupons? big smiles and karma points?), let us know!

To anyone who's worried about the quality of community-sourced answers: we're always going to monitor every discussion, so rest assured that there won't be any decrease on quality. Who knows, there may even be an increase! ;-)

Thank you!

Created 2016-04-28 08:44:01 | Updated | Tags: baserecalibrator documentation inputs

Comments (1)

I am trying to run the BaseRecalibrator on plant data for which I have no SNP or INDEL data. The documentation clearly states that providing a set of known variants is OPTIONAL, but the program crashes. What is going on and how do I run the program without the SNPs which are not available? I have followed the pipeline given in the Best Practices and want to see it through.

Documentation for the tool:


States the following:

"Optional Inputs" "--knownSites NA A database of known polymorphic sites"

However, I get this message:

ERROR MESSAGE: Invalid command line: This calculation is critically dependent on being able to mask out known variant sites. Please provide a VCF file containing known sites of genetic variation.

Should I simply not bother with this step and just run the Haplotype Caller? And will this yield equally good results?


Created 2015-11-17 09:10:37 | Updated | Tags: documentation json

Comments (3)

in https://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_gatk_tools_walkers_variantutils_SelectVariants.php.json

  "summary": "Output variants not called in this comparison track",
      "name": "--discordance",

      "kind": "optional_in",

'kind' should be optional_out isn't it ?

Created 2015-07-31 01:07:30 | Updated | Tags: documentation strand-bias

Comments (1)

There seems to be a documentation error on this page: https://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_gatk_tools_walkers_annotator_StrandOddsRatio.php

refRatio and altRatio should be calculated as min/max rather than max/min values. That is what is in code here: https://github.com/broadgsa/gatk-protected/blob/master/protected/gatk-tools-protected/src/main/java/org/broadinstitute/gatk/tools/walkers/annotator/StrandOddsRatio.java assuming the two correspond to each other. I coded it the same way myself and get more precise results too.

Created 2015-06-29 19:50:14 | Updated | Tags: documentation

Comments (1)


Amount of padding (in bp) to add to each interval Use this to add padding to the intervals specified using -L and/or -XL. For example, '-L chr1:100' with a padding value of 20 would turn into '-L chr1:80-120'. This is typically used to add padding around exons when analyzing exomes. The general Broad exome calling pipeline uses 100 bp padding by default.

I think it sould not be '-L chr1:80-120'

Created 2015-01-02 00:00:17 | Updated | Tags: documentation source-code

Comments (11)

I recently start consider to use more GATK and Queue and develop my analysis tools with it. I intend to figure out how to generate jar files for GATK or Queue. I will import the files into Scala IDE for ease of viewing inline source code and code documentation. Should I try doing that or there is a simpler way?

Created 2013-12-18 21:52:37 | Updated | Tags: documentation depthofcoverage parallelism

Comments (8)

http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_coverage_DepthOfCoverage.html states (bold is my emphasis):

Parallelism options

This tool can be run in multi-threaded mode using this option.

TreeReducible (-nt)

Yet when I run the GATK with -nt, I get an error that -nt is not supported (truncated to save space):

ERROR A USER ERROR has occurred (version 2.8-1-g932cd3a): ERROR MESSAGE: Invalid command line: Argument nt has a bad value: The analysis DepthOfCoverage aggregates results by interval. Due to a current limitation of the GATK, analyses of this type do not currently support parallel execution. Please run your analysis without the -nt option.

Created 2013-07-11 23:08:11 | Updated 2013-07-11 23:08:34 | Tags: baserecalibrator documentation analyzecovariates

Comments (1)

In GATK 2.6, there have been some changes to BaseRecalibrator. Based on the AnalyzeCovariates page, it must now be run twice. To generate the first pass recalibration table file, it's the same command as before. To generate the second pass recalibration table file, you need to add the -BQSR argument. However, on the BaseRecalibrator page, there is no -BQSR documentation.

Created 2013-03-01 12:16:11 | Updated | Tags: documentation output

Comments (6)

Hi, I use the option to get extended output from mutect and it works well. Unfortunately I cannot find a detailed description of all the columns, only the ones that are in the regular output. Is it possible to have this kind of documentation? thanks a lot

Created 2012-11-22 21:09:04 | Updated | Tags: documentation selectvariants varianteval

Comments (3)


I've a couple of essentially documentation-centric questions...

Firstly, the SelectVariants documentation describes selecting 1000 random variants from a vcf using '-number 1000', however when I try that (with the command "java -jar GenomeAnalysisTK.jar -T SelectVariants -R human_g1k_v37.fasta --variant variants.vcf -o 1000.vcf -number 1000") it produces the error 'Argument with the name number isn't defined'. Trying --number instead doesn't make any difference, while the --help output does not list this argument (GATK 2.2.2). It this option no longer available?

Secondly, the 'gatkforums.broadinstitute.org/discussion/48/using-varianteval#Understanding_Genotype_Concordance_values_from_Variant_Eval' section of the 'Using VariantEval' page has a series of images explaining the concordance values, however the images are missing. Please could these be restored?

Many thanks, James