Google_Service_Genomics_ReadgroupsetsCoveragebuckets_Resource Class Reference

The "coveragebuckets" collection of methods. More...

Inheritance diagram for Google_Service_Genomics_ReadgroupsetsCoveragebuckets_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	listReadgroupsetsCoveragebuckets ($readGroupSetId, $optParams=array())
	Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "coveragebuckets" collection of methods.

Typical usage is: $genomicsService = new Google_Service_Genomics(...); $coveragebuckets = $genomicsService->coveragebuckets;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

listReadgroupsetsCoveragebuckets()

Google_Service_Genomics_ReadgroupsetsCoveragebuckets_Resource::listReadgroupsetsCoveragebuckets	(		$readGroupSetId,
			$optParams = array() )

Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence.

Each bucket summarizes coverage information across its corresponding genomic range. Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at several precomputed bucket widths, enabling retrieval of various coverage 'zoom levels'. The caller must have READ permissions for the target read group set. (coveragebuckets.listReadgroupsetsCoveragebuckets)

Parameters

string	$readGroupSetId	Required. The ID of the read group set over which coverage is requested.
array	$optParams	Optional parameters.

@opt_param string end The end position of the range on the reference, 0-based exclusive. If specified, referenceName must also be specified. If unset or 0, defaults to the length of the reference. @opt_param int pageSize The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 2048. @opt_param string start The start position of the range on the reference, 0-based inclusive. If specified, referenceName must also be specified. Defaults to 0. @opt_param string pageToken The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response. @opt_param string targetBucketWidth The desired width of each reported coverage bucket in base pairs. This will be rounded down to the nearest precomputed bucket width; the value of which is returned as bucketWidth in the response. Defaults to infinity (each bucket spans an entire reference sequence) or the length of the target range, if specified. The smallest precomputed bucketWidth is currently 2048 base pairs; this is subject to change. @opt_param string referenceName The name of the reference to query, within the reference set associated with this query. Optional.

Return values

Google_Service_Genomics_ListCoverageBucketsResponse

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Genomics.php