9acffdf932d10e14764c201dd48455aa60b45a79 lrnassar Mon Jul 22 13:17:59 2019 -0700 Updating api.html with new /list/schema function #23777 diff --git src/hg/htdocs/goldenPath/help/api.html src/hg/htdocs/goldenPath/help/api.html index 3dcfe51..2708d25 100755 --- src/hg/htdocs/goldenPath/help/api.html +++ src/hg/htdocs/goldenPath/help/api.html @@ -199,30 +199,33 @@ target=_blank>list tracks from specified hub and genome</a> - <b>api.genome.ucsc.edu/list/tracks?hubUrl=http://hgdownload.soe.ucsc.edu/hubs/mouseStrains/hub.txt;genome=CAST_EiJ</b></li> <li><a href='https://api.genome.ucsc.edu/list/tracks?genome=hg38' target=_blank>list tracks from UCSC database genome</a> - <b>api.genome.ucsc.edu/list/tracks?genome=hg38</b></li> <li><a href='https://api.genome.ucsc.edu/list/chromosomes?genome=hg38' target=_blank>list chromosomes from UCSC database genome</a> - <b>api.genome.ucsc.edu/list/chromosomes?genome=hg38</b></li> <li><a href='https://api.genome.ucsc.edu/list/chromosomes?genome=hg38;track=gold' target=_blank>list chromosomes from specified track in UCSC database genome</a> - <b>api.genome.ucsc.edu/list/chromosomes?genome=hg38;track=gold</b></li> <li><a href='https://api.genome.ucsc.edu/list/chromosomes?hubUrl=http://hgdownload.soe.ucsc.edu/hubs/mouseStrains/hub.txt;genome=CAST_EiJ' target=_blank>list chromosomes from assembly hub genome</a> - <br><b>api.genome.ucsc.edu/list/chromosomes?hubUrl=http://hgdownload.soe.ucsc.edu/hubs/mouseStrains/hub.txt;genome=CAST_EiJ</b></li> <li><a href='https://api.genome.ucsc.edu/list/chromosomes?hubUrl=http://hgdownload.soe.ucsc.edu/hubs/mouseStrains/hub.txt;genome=CAST_EiJ;track=assembly' target=_blank>list chromosomes from specified track in assembly hub genome</a> - <br><b>api.genome.ucsc.edu/list/chromosomes?hubUrl=hubUrl=http://hgdownload.soe.ucsc.edu/hubs/mouseStrains/hub.txt;genome=CAST_EiJ;track=assembly</b></li> +<li><a href='https://api.genome.ucsc.edu/list/schema?genome=hg38;track=knownGene' +target=_blank>list schema from specified track in UCSC database genome</a> - +<br><b>api.genome.ucsc.edu/list/schema?genome=hg38;track=knownGene</b></li> </ol> <a id="getData_examples"></a> <h3>getData functions</h3> <ol> <li><a href='https://api.genome.ucsc.edu/getData/sequence?genome=hg38;chrom=chrM' target=_blank>Get DNA sequence from specified chromosome in UCSC database genome</a> - <br><b>api.genome.ucsc.edu/getData/sequence?genome=hg38;chrom=chrM</b></li> <li><a href='https://api.genome.ucsc.edu/getData/sequence?genome=hg38;chrom=chrM;start=4321;end=5678' target=_blank>Get DNA sequence from specified chromosome and start,end coordinates in UCSC database genome</a> - <br><b>api.genome.ucsc.edu/getData/sequence?genome=hg38;chrom=chrM;start=4321;end=5678</b></li> <li><a href='https://api.genome.ucsc.edu/getData/sequence?hubUrl=http://hgdownload.soe.ucsc.edu/hubs/mouseStrains/hub.txt;genome=mm10;chrom=chrM;start=4321;end=5678' target=_blank>Get DNA sequence from a track hub where 'genome' is a UCSC database</a> - <br><b>api.genome.ucsc.edu/getData/sequence?hubUrl=http://hgdownload.soe.ucsc.edu/hubs/mouseStrains/hub.txt;genome=mm10;chrom=chrM;start=4321;end=5678</b></li> <li><a href='https://api.genome.ucsc.edu/getData/sequence?hubUrl=http://hgdownload.soe.ucsc.edu/hubs/mouseStrains/hub.txt;genome=CAST_EiJ;chrom=chr1;start=4321;end=5678' target=_blank>Get DNA sequence from specified chromosome and start,end coordinates in an assembly hub genome</a> - @@ -271,30 +274,40 @@ <li><a href='https://api.genome.ucsc.edu/getData/track?genome=hg19;track=decipherSnvs' target=_blank>Request track data from a restricted track</a>. See <a href='../../FAQ/FAQdownloads.html#download40' target=_blank>FAQ</a> - <br><b>api.genome.ucsc.edu/getData/track?genome=hg19;track=decipherSnvs</b></li> </ol> </p> <!-- ========== Practical Examples ======================= --> <a id="Practical_examples"></a> <h2>Practical examples</h2> <h3>Looking up the schema of a specific track</h3> <p> +The easiest way to get the schema for a track is to use the <b>/list/schema</b> function. This +can be used on both file tracks and table tracks: + +<p> +<a href='https://api.genome.ucsc.edu/list/schema?genome=hg38;track=crispr10KTargets' +target=_blank>Request schema for the hg38 CRISPR 10K Targets track</a> - +<br><b>api.genome.ucsc.edu/list/schema?genome=hg38;track=crispr10KTargets</b></p> + +<p> +There is a second indirect way to get the schema which may be preferable in certain cases. When querying track data with the <b>/getData/track</b> function, the <b>jsonOutputArrays</b> can be used in conjunction to see the track schema. This includes a description of each field present in the track. The data will also be returned in JSON array type.</p> <p> <a href='https://api.genome.ucsc.edu/getData/track?genome=hg38;track=gold;chrom=chrM;jsonOutputArrays=1' target=_blank>Request data from hg38 gold track in array type</a> - <br><b>api.genome.ucsc.edu/getData/track?genome=hg38;track=gold;chrom=chrM;jsonOutputArrays=1</b></p> <h3>Hide track container information with trackLeavesOnly parameter</h3> <p> When using the <b>/list/tracks</b> function to see the available tracks in an assembly, it can be useful to return all tracks in the same hierarchical level. By default, composite and supertracks will have the subtracks nested below, however, the <b>trackLeavesOnly=1</b> parameter