Package org.broadinstitute.hellbender.utils.help

Class HelpConstants

java.lang.Object

org.broadinstitute.hellbender.utils.help.HelpConstants

public final class HelpConstants
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOC_CAT_ANNOTATORS	Definition of the group names / descriptions for documentation/help purposes.
static final String	DOC_CAT_ANNOTATORS_SUMMARY
static final String	DOC_CAT_CNV
static final String	DOC_CAT_CNV_SUMMARY
static final String	DOC_CAT_COVERAGE_ANALYSIS
static final String	DOC_CAT_COVERAGE_ANALYSIS_SUMMARY
static final String	DOC_CAT_EXAMPLE
static final String	DOC_CAT_EXAMPLE_SUMMARY
static final String	DOC_CAT_FLOW_ANNOTATORS
static final String	DOC_CAT_FLOW_ANNOTATORS_SUMMARY
static final String	DOC_CAT_METAGENOMICS
static final String	DOC_CAT_METAGENOMICS_SUMMARY
static final String	DOC_CAT_METHYLATION_DISCOVERY
static final String	DOC_CAT_METHYLATION_DISCOVERY_SUMMARY
static final String	DOC_CAT_READFILTERS
static final String	DOC_CAT_READFILTERS_SUMMARY
static final String	DOC_CAT_RNA
static final String	DOC_CAT_RNA_SUMMARY
static final String	DOC_CAT_SHORT_FLOW_BASED
static final String	DOC_CAT_SHORT_FLOW_BASED_SUMMARY
static final String	DOC_CAT_SHORT_VARIANT_DISCOVERY
static final String	DOC_CAT_SHORT_VARIANT_DISCOVERY_SUMMARY
static final String	DOC_CAT_SV_DISCOVERY
static final String	DOC_CAT_SV_DISCOVERY_SUMMARY
static final String	DOC_CAT_TEST
static final String	DOC_CAT_TEST_SUMMARY
static final String	GATK_FORUM_URL
static final String	GATK_MAIN_SITE

Method Summary

Modifier and Type	Method	Description
static String	forumPost(String post)
static String	getSuperCategoryProperty(String groupName)	Given a group name, return a supercategory string for use by the online doc system to determine which supercateogry the group is in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

GATK_FORUM_URL

public static final String GATK_FORUM_URL

See Also:

• Constant Field Values

GATK_MAIN_SITE

public static final String GATK_MAIN_SITE

See Also:

• Constant Field Values

DOC_CAT_ANNOTATORS

public static final String DOC_CAT_ANNOTATORS

Definition of the group names / descriptions for documentation/help purposes.

See Also:

• Constant Field Values

DOC_CAT_ANNOTATORS_SUMMARY

public static final String DOC_CAT_ANNOTATORS_SUMMARY

See Also:

• Constant Field Values

DOC_CAT_FLOW_ANNOTATORS

public static final String DOC_CAT_FLOW_ANNOTATORS

See Also:

• Constant Field Values

DOC_CAT_FLOW_ANNOTATORS_SUMMARY

public static final String DOC_CAT_FLOW_ANNOTATORS_SUMMARY

See Also:

• Constant Field Values

DOC_CAT_COVERAGE_ANALYSIS

public static final String DOC_CAT_COVERAGE_ANALYSIS

See Also:

• Constant Field Values

DOC_CAT_COVERAGE_ANALYSIS_SUMMARY

public static final String DOC_CAT_COVERAGE_ANALYSIS_SUMMARY

See Also:

• Constant Field Values

DOC_CAT_CNV

public static final String DOC_CAT_CNV

See Also:

• Constant Field Values

DOC_CAT_CNV_SUMMARY

public static final String DOC_CAT_CNV_SUMMARY

See Also:

• Constant Field Values

DOC_CAT_EXAMPLE

public static final String DOC_CAT_EXAMPLE

See Also:

• Constant Field Values

DOC_CAT_EXAMPLE_SUMMARY

public static final String DOC_CAT_EXAMPLE_SUMMARY

See Also:

• Constant Field Values

DOC_CAT_METAGENOMICS

public static final String DOC_CAT_METAGENOMICS

See Also:

• Constant Field Values

DOC_CAT_METAGENOMICS_SUMMARY

public static final String DOC_CAT_METAGENOMICS_SUMMARY

See Also:

• Constant Field Values

DOC_CAT_READFILTERS

public static final String DOC_CAT_READFILTERS

See Also:

• Constant Field Values

DOC_CAT_READFILTERS_SUMMARY

public static final String DOC_CAT_READFILTERS_SUMMARY

See Also:

• Constant Field Values

DOC_CAT_SHORT_VARIANT_DISCOVERY

public static final String DOC_CAT_SHORT_VARIANT_DISCOVERY

See Also:

• Constant Field Values

DOC_CAT_SHORT_VARIANT_DISCOVERY_SUMMARY

public static final String DOC_CAT_SHORT_VARIANT_DISCOVERY_SUMMARY

See Also:

• Constant Field Values

DOC_CAT_SV_DISCOVERY

public static final String DOC_CAT_SV_DISCOVERY

See Also:

• Constant Field Values

DOC_CAT_SV_DISCOVERY_SUMMARY

public static final String DOC_CAT_SV_DISCOVERY_SUMMARY

See Also:

• Constant Field Values

DOC_CAT_TEST

public static final String DOC_CAT_TEST

See Also:

• Constant Field Values

DOC_CAT_TEST_SUMMARY

public static final String DOC_CAT_TEST_SUMMARY

See Also:

• Constant Field Values

DOC_CAT_RNA

public static final String DOC_CAT_RNA

See Also:

• Constant Field Values

DOC_CAT_RNA_SUMMARY

public static final String DOC_CAT_RNA_SUMMARY

See Also:

• Constant Field Values

DOC_CAT_METHYLATION_DISCOVERY

public static final String DOC_CAT_METHYLATION_DISCOVERY

See Also:

• Constant Field Values

DOC_CAT_METHYLATION_DISCOVERY_SUMMARY

public static final String DOC_CAT_METHYLATION_DISCOVERY_SUMMARY

See Also:

• Constant Field Values

DOC_CAT_SHORT_FLOW_BASED

public static final String DOC_CAT_SHORT_FLOW_BASED

See Also:

• Constant Field Values

DOC_CAT_SHORT_FLOW_BASED_SUMMARY

public static final String DOC_CAT_SHORT_FLOW_BASED_SUMMARY

See Also:

• Constant Field Values

Method Details

forumPost

public static String forumPost(String post)

getSuperCategoryProperty

public static String getSuperCategoryProperty(String groupName)

Given a group name, return a supercategory string for use by the online doc system to determine which supercateogry the group is in. The strings returned by this method should match those used in the corresponding help template.

Parameters:

groupName -

Returns:

supercategory string corresponding to groupName for use in for use in determining which supercateogry the group is in for online doc purposes.