Home | History | Annotate | Download | only in dyn 
      1 <html><body>
      2 <style>
      3 
      4 body, h1, h2, h3, div, span, p, pre, a {
      5   margin: 0;
      6   padding: 0;
      7   border: 0;
      8   font-weight: inherit;
      9   font-style: inherit;
     10   font-size: 100%;
     11   font-family: inherit;
     12   vertical-align: baseline;
     13 }
     14 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, h2, h3 {
     50   border-bottom: solid #CCC 1px;
     51 }
     52 
     53 .toc_element {
     54   margin-top: 0.5em;
     55 }
     56 
     57 .firstline {
     58   margin-left: 2 em;
     59 }
     60 
     61 .method  {
     62   margin-top: 1em;
     63   border: solid 1px #CCC;
     64   padding: 1em;
     65   background: #EEE;
     66 }
     67 
     68 .details {
     69   font-weight: bold;
     70   font-size: 14px;
     71 }
     72 
     73 </style>
     74 
     75 <h1><a href="genomics_v1.html">Genomics API</a> . <a href="genomics_v1.readgroupsets.html">readgroupsets</a> . <a href="genomics_v1.readgroupsets.coveragebuckets.html">coveragebuckets</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#list">list(readGroupSetId, targetBucketWidth=None, x__xgafv=None, end=None, start=None, referenceName=None, pageToken=None, pageSize=None)</a></code></p>
     79 <p class="firstline">Lists fixed width coverage buckets for a read group set, each of which</p>
     80 <p class="toc_element">
     81   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     82 <p class="firstline">Retrieves the next page of results.</p>
     83 <h3>Method Details</h3>
     84 <div class="method">
     85     <code class="details" id="list">list(readGroupSetId, targetBucketWidth=None, x__xgafv=None, end=None, start=None, referenceName=None, pageToken=None, pageSize=None)</code>
     86   <pre>Lists fixed width coverage buckets for a read group set, each of which
     87 correspond to a range of a reference sequence. Each bucket summarizes
     88 coverage information across its corresponding genomic range.
     89 
     90 For the definitions of read group sets and other genomics resources, see
     91 [Fundamentals of Google
     92 Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
     93 
     94 Coverage is defined as the number of reads which are aligned to a given
     95 base in the reference sequence. Coverage buckets are available at several
     96 precomputed bucket widths, enabling retrieval of various coverage 'zoom
     97 levels'. The caller must have READ permissions for the target read group
     98 set.
     99 
    100 Args:
    101   readGroupSetId: string, Required. The ID of the read group set over which coverage is requested. (required)
    102   targetBucketWidth: string, The desired width of each reported coverage bucket in base pairs. This
    103 will be rounded down to the nearest precomputed bucket width; the value
    104 of which is returned as `bucketWidth` in the response. Defaults
    105 to infinity (each bucket spans an entire reference sequence) or the length
    106 of the target range, if specified. The smallest precomputed
    107 `bucketWidth` is currently 2048 base pairs; this is subject to
    108 change.
    109   x__xgafv: string, V1 error format.
    110     Allowed values
    111       1 - v1 error format
    112       2 - v2 error format
    113   end: string, The end position of the range on the reference, 0-based exclusive. If
    114 specified, `referenceName` must also be specified. If unset or 0, defaults
    115 to the length of the reference.
    116   start: string, The start position of the range on the reference, 0-based inclusive. If
    117 specified, `referenceName` must also be specified. Defaults to 0.
    118   referenceName: string, The name of the reference to query, within the reference set associated
    119 with this query. Optional.
    120   pageToken: string, The continuation token, which is used to page through large result sets.
    121 To get the next page of results, set this parameter to the value of
    122 `nextPageToken` from the previous response.
    123   pageSize: integer, The maximum number of results to return in a single page. If unspecified,
    124 defaults to 1024. The maximum value is 2048.
    125 
    126 Returns:
    127   An object of the form:
    128 
    129     {
    130     "nextPageToken": "A String", # The continuation token, which is used to page through large result sets.
    131         # Provide this value in a subsequent request to return the next page of
    132         # results. This field will be empty if there aren't any additional results.
    133     "coverageBuckets": [ # The coverage buckets. The list of buckets is sparse; a bucket with 0
    134         # overlapping reads is not returned. A bucket never crosses more than one
    135         # reference sequence. Each bucket has width `bucketWidth`, unless
    136         # its end is the end of the reference sequence.
    137       { # A bucket over which read coverage has been precomputed. A bucket corresponds
    138           # to a specific range of the reference sequence.
    139         "meanCoverage": 3.14, # The average number of reads which are aligned to each individual
    140             # reference base in this bucket.
    141         "range": { # A 0-based half-open genomic coordinate range for search requests. # The genomic coordinate range spanned by this bucket.
    142           "start": "A String", # The start position of the range on the reference, 0-based inclusive.
    143           "end": "A String", # The end position of the range on the reference, 0-based exclusive.
    144           "referenceName": "A String", # The reference sequence name, for example `chr1`,
    145               # `1`, or `chrX`.
    146         },
    147       },
    148     ],
    149     "bucketWidth": "A String", # The length of each coverage bucket in base pairs. Note that buckets at the
    150         # end of a reference sequence may be shorter. This value is omitted if the
    151         # bucket width is infinity (the default behaviour, with no range or
    152         # `targetBucketWidth`).
    153   }</pre>
    154 </div>
    155 
    156 <div class="method">
    157     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    158   <pre>Retrieves the next page of results.
    159 
    160 Args:
    161   previous_request: The request for the previous page. (required)
    162   previous_response: The response from the request for the previous page. (required)
    163 
    164 Returns:
    165   A request object that you can call 'execute()' on to request the next
    166   page. Returns None if there are no more items in the collection.
    167     </pre>
    168 </div>
    169 
    170 </body></html>