broadinstitute / gatk-protected

Obsolete/Legacy GATK repository -- go to https://github.com/broadinstitute/gatk instead
BSD 3-Clause "New" or "Revised" License
33 stars 20 forks source link

CNV performallelefractionsegmentation: tag doc #1120

Closed sooheelee closed 7 years ago

sooheelee commented 7 years ago
samuelklee commented 7 years ago

Copying comments from closed branch:

No example command since there is no WDL for me to reference. FYI @LeeTL1220 @achevali.

There is no WDL because this tool is experimental. In general, you should be able to put together example command lines from the integration tests for a tool.

tag doc and mention that the tumorHets file is from GetHetCoverage.

We should probably say that the tumorHets file is from GetBayesianHetCoverage, preferably, but can also come from GetHetCoverage.

sooheelee commented 7 years ago

@samuelklee I looked into the IntegrationTest and did not see an obvious command structure or references to files in our resource suite except for the file that I give an example of.

samuelklee commented 7 years ago

The following block from PerformAlleleFractionSegmentationIntegrationTest can be translated into a command line (with a little bit of work):

final String[] arguments = {
            "-" + ExomeStandardArgumentDefinitions.TUMOR_ALLELIC_COUNTS_FILE_SHORT_NAME, snpFile.getAbsolutePath(),
            "-" + PerformAlleleFractionSegmentation.INITIAL_NUM_STATES_SHORT_NAME, Integer.toString(initialNumStates),
            "-" + ExomeStandardArgumentDefinitions.SEGMENT_FILE_SHORT_NAME, outputSegmentFile.getAbsolutePath()
    };
sooheelee commented 7 years ago

This is missing the documentation tag.