ba9090c1767c6cab887fba49b2439f7cabc74e99 gperez2 Tue Nov 1 17:50:58 2022 -0700 Code review edits and updates for the public hub guidelines page, refs #28424 diff --git src/hg/htdocs/goldenPath/help/publicHubGuidelines.html src/hg/htdocs/goldenPath/help/publicHubGuidelines.html index 805eb57..88706f5 100755 --- src/hg/htdocs/goldenPath/help/publicHubGuidelines.html +++ src/hg/htdocs/goldenPath/help/publicHubGuidelines.html @@ -7,87 +7,87 @@

Public Hub Guidelines

The Genome Browser provides links to a collection of public hubs that have been registered with UCSC and are available to view on the Public Hubs page. Here are guidelines for those who are trying to make a hub a UCSC public hub. If you have created a hub that meets the requirements and is of general interest to the research community, please contact us at genome-www@soe.ucsc.edu to have it added to the list. -

As a reference for interpreting trackDb.txt settings use the Hub Track Database Definition As a reference for interpreting trackDb.txt settings, use the Hub Track Database Definition glossary. For information on using the Track Hub features, refer to the Genome Browser Track Hub User Guide. See also the Basic Hub Quick Start Guide, Quick Start Guide to Organizing Track Hubs into Groupings, Track hub settings blog post, Quick Start Guide to Assembly Hubs and Quick Start Guide to Searchable Track Hubs.

Contents

Required Guidelines
Recommended Guidelines
Public Hub Examples

Required Guidelines

The following guidelines must be met before your hub will be added to our public list:

Required for both track and assembly hubs:

Required for only assembly hubs:

Recommended Guidelines

These guidelines in the following sections are recommended to improve user experience, but are not required to be implemented before the hub is added to our list of Public Hubs.

Track organization recommendations

Related tracks can be grouped in a few different ways, namely superTracks, multiWigs, and composites. If your hub includes a large number of tracks, the grouping of tracks may be necessary. This will prevent your hub's track group from being an overwhelming mess of individual tracks and can make user configuration of your tracks easier.

@@ -101,60 +101,60 @@ more than one view. Views ideally give alternate access to the same data (e.g. signals and called peaks). Keep in mind that the value of views is that they allow for more than one data/configuration type (e.g. bigBed and bigWig) in a single composite. All subtracks of a view must have the same data type. Likewise, all subtracks of a non-multi-view composite must be the same type.
  • Recommendations for using dimensions with your composite tracks:
    1. There should be no dimensions with a single entry (do not have only one cell line represented in dimX=cell), unless data growth is expected to fill in additional entries.
    2. Using only one dimension: preferably use dimX (e.g. dimensions dimX=cell). This saves vertical User Interface space, but is not always the best choice.
    3. Using two dimensions: use dimX and dimY (e.g. dimensions dimX=cell dimY=mark)
    4. Using more than two: use dimX, dimY on the most important dimensions. Then use dimA,B,C as needed on lesser dimensions. (e.g. dimensions dimX=cell dimY=mark dimA=donor_id)
    5. -
    6. The A,B,C.. dimensions should probably use The A,B,C dimensions should probably use filterComposite (e.g. filterComposite dimA)
    7. Each dimension and views should be represented in sortOrder, ideally in order of dimX, dimY, dimA,B,C, view (e.g. sortOrder cell_type=+ mark=+ donor_id=+ view=+).
    8. Tags of subGroup/dimension should be short and sweet with no special chars. Also labels can have HTML codes embedded (e.g. NOT CPG_methylation_%=CPG_methylation_% RATHER - mpct=CPG_methylation_&_#37
    9. + mpct=CPG_methylation_&_#37)
    10. Never represent the same subgroup in both view and as a dimension (e.g. NOT dimensions dimX=view). A subgroup should never be in two dimensions (e.g. NOT dimensions dimX=cell dimY=mark dimA=cell). The composite will appear to function but multiple ways of - selecting the same thing will create a confusing and inconsistent User Interface.
    11. + selecting the same thing will create a confusing and inconsistent user interface.
    Super tracks

    Extremely large hubs may use superTracks as well to achieve a meaningful hierarchy. Super tracks can be used to group together any type of related tracks; for example, you could combine a multiWig, -a composite and a bigBed track together into a single superTrack.

    +a composite, and a bigBed track together into a single superTrack.

    Track display recommendations

    Track description page recommendations