Package picard.util.help
Class HelpConstants
java.lang.Object
picard.util.help.HelpConstants
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Definition of the group names / descriptions for documentation/help purposes.static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
List of "supercategory" values used for doc purposes.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic 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.
-
Field Details
-
DOC_CAT_BASE_CALLING
Definition of the group names / descriptions for documentation/help purposes.- See Also:
-
DOC_CAT_BASE_CALLING_SUMMARY
- See Also:
-
DOC_CAT_DIAGNOSTICS_AND_QC
- See Also:
-
DOC_CAT_DIAGNOSTICS_AND_QC_SUMMARY
- See Also:
-
DOC_CAT_INTERVALS_MANIPULATION
- See Also:
-
DOC_CAT_INTERVALS_MANIPULATION_SUMMARY
- See Also:
-
DOC_CAT_OTHER
- See Also:
-
DOC_CAT_OTHER_SUMMARY
- See Also:
-
DOC_CAT_READ_DATA_MANIPULATION
- See Also:
-
DOC_CAT_READ_DATA_MANIPULATION_SUMMARY
- See Also:
-
DOC_CAT_REFERENCE
- See Also:
-
DOC_CAT_REFERENCE_SUMMARY
- See Also:
-
DOC_CAT_TEST
- See Also:
-
DOC_CAT_TEST_SUMMARY
- See Also:
-
DOC_CAT_VARIANT_FILTERING
- See Also:
-
DOC_CAT_VARIANT_FILTERING_SUMMARY
- See Also:
-
DOC_CAT_VARIANT_EVALUATION
- See Also:
-
DOC_CAT_VARIANT_EVALUATION_SUMMARY
- See Also:
-
DOC_CAT_VARIANT_MANIPULATION
- See Also:
-
DOC_CAT_VARIANT_MANIPULATION_SUMMARY
- See Also:
-
DOC_CAT_GENOTYPING_ARRAYS_MANIPULATION
- See Also:
-
DOC_CAT_GENOTYPING_ARRAYS_MANIPULATION_SUMMARY
- See Also:
-
DOC_CAT_METRICS
- See Also:
-
DOC_CAT_METRICS_SUMMARY
- See Also:
-
DOC_SUPERCAT_TOOLS
List of "supercategory" values used for doc purposes. Every doc group name can/should be put into one of the following supercategories.- See Also:
-
DOC_SUPERCAT_UTILITIES
- See Also:
-
DOC_SUPERCAT_EXCLUDE
- See Also:
-
-
Method Details
-
getSuperCategoryMap
-
getSuperCategoryProperty
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 supercategory the group is in for online doc purposes.
-