Google_Service_Genomics_ReadgroupsetsCoveragebuckets_Resource

The "coveragebuckets" collection of methods.

Defined (1)

The class is defined in the following location(s).

/includes/api-libs/Google/Service/Genomics.php  
  1. class Google_Service_Genomics_ReadgroupsetsCoveragebuckets_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Lists fixed width coverage buckets for a read group set, each of which 
  5. * correspond to a range of a reference sequence. Each bucket summarizes 
  6. * coverage information across its corresponding genomic range. 
  7. * Coverage is defined as the number of reads which are aligned to a given base 
  8. * in the reference sequence. Coverage buckets are available at several 
  9. * precomputed bucket widths, enabling retrieval of various coverage 'zoom 
  10. * levels'. The caller must have READ permissions for the target read group set. 
  11. * (coveragebuckets.listReadgroupsetsCoveragebuckets) 
  12. * @param string $readGroupSetId Required. The ID of the read group set over 
  13. * which coverage is requested. 
  14. * @param array $optParams Optional parameters. 
  15. * @opt_param int pageSize The maximum number of results to return in a single 
  16. * page. If unspecified, defaults to 1024. The maximum value is 2048. 
  17. * @opt_param string range.start The start position of the range on the 
  18. * reference, 0-based inclusive. If specified, referenceName must also be 
  19. * specified. 
  20. * @opt_param string range.end The end position of the range on the reference,  
  21. * 0-based exclusive. If specified, referenceName must also be specified. 
  22. * @opt_param string range.referenceName The reference sequence name, for 
  23. * example chr1, 1, or chrX. 
  24. * @opt_param string pageToken The continuation token, which is used to page 
  25. * through large result sets. To get the next page of results, set this 
  26. * parameter to the value of nextPageToken from the previous response. 
  27. * @opt_param string targetBucketWidth The desired width of each reported 
  28. * coverage bucket in base pairs. This will be rounded down to the nearest 
  29. * precomputed bucket width; the value of which is returned as bucketWidth in 
  30. * the response. Defaults to infinity (each bucket spans an entire reference 
  31. * sequence) or the length of the target range, if specified. The smallest 
  32. * precomputed bucketWidth is currently 2048 base pairs; this is subject to 
  33. * change. 
  34. * @return Google_Service_Genomics_ListCoverageBucketsResponse 
  35. */ 
  36. public function listReadgroupsetsCoveragebuckets($readGroupSetId, $optParams = array()) 
  37. $params = array('readGroupSetId' => $readGroupSetId); 
  38. $params = array_merge($params, $optParams); 
  39. return $this->call('list', array($params), "Google_Service_Genomics_ListCoverageBucketsResponse");