iCLIP.getters.getter

iCLIP.getters.getter(contig, start=0, end=None, strand='.', dtype='uint16')

Get the profile of crosslinks across a genomic region, returning the number of crosslinks on each base.

This stub defines the abstract interface for a getter function. Getters are made by calling the make_getter() function. The returned function will have the interface specified here.

Parameters:
  • contig (str) –
  • start (int, optional) –
  • end (int or None, optional) – If None specified then profile will be returned from 0 to end of contig.
  • strand (['.','+','-'], optional) – strand to return counts from. If . then data from both strands is returned.
  • dtype (str) – dtype to use for storing data. Usually a type of unsigned int. Larger size ints are less likely to overflow, but take more memeory.
Returns:

Profile of crosslinks. Index is the genomic base, value is the count. Series is sparse, that is bases with no crosslinks are excluded from the index.

Return type:

pandas.Series

See also

make_getter()
genearate a getter function from a bamfile or BigWig file(s)