bbcflib::bFlatMajor::figure::rplots Namespace Reference

Functions
def	scatterplot
def	lineplot
def	boxplot
def	heatmap
def	pairs

---

Detailed Description

These functions use `rpy2` to bind *R* plotting functions with data from numpy arrays. 
Each function takes the following arguments:

* output: the filename, a random name will be generated if this is None (default None),
* format: the image format, 'pdf' (default) or 'png',
* new: boolean indicating if a new figure must be started (default) or if the plot is added to the current figure,
* last: boolean, if true this is the last plot on this figure, the file will be finalized and close on return.
* **kwargs: additional parameters for *R*, such as 'xlab', 'ylab', 'main, 'mfrow', 'log', 'legend'.

---

Function Documentation

def bbcflib::bFlatMajor::figure::rplots::boxplot	(		values,
			labels,
			output = None,
			format = 'pdf',
			new = True,
			last = True,
			kwargs
	)

Creates a box-and-whiskers plot of `values` split by `labels`.

def bbcflib::bFlatMajor::figure::rplots::heatmap	(		M,
			output = None,
			format = 'pdf',
			new = True,
			last = True,
			rows = None,
			columns = None,
			orderRows = True,
			orderCols = True,
			kwargs
	)

Creates a heatmap of the matrix `M` using `rows` as row labels and `columns` as column labels.
If either `orderRows` or `orderCols` is True, will cluster accordingly and display a dendrogram.

def bbcflib::bFlatMajor::figure::rplots::lineplot	(		X,
			Y,
			output = None,
			format = 'pdf',
			new = True,
			last = True,
			kwargs
	)

Creates a line plot of X vs Y. 
 If Y is a list of arrays, a different color will be used for each of them.

def bbcflib::bFlatMajor::figure::rplots::pairs	(		M,
			X = None,
			output = None,
			format = 'pdf',
			new = True,
			last = True,
			rows = None,
			columns = None,
			orderRows = True,
			orderCols = True,
			kwargs
	)

Pairs plot. 
If *X* is a vector of length *m*, *M* must be an *(n-1)n/2 x m* matrix and the *(i,j)* plot will show *M[ni+j,] ~ X* as a line plot. 
If *X* is `None` then *M* must be an *n x m* matrix and the *(i,j)* plot will show *M[i,] ~ M[j,]* as a density plot.

def bbcflib::bFlatMajor::figure::rplots::scatterplot	(		X,
			Y,
			output = None,
			format = 'pdf',
			new = True,
			last = True,
			kwargs
	)

Creates a scatter plot of X vs Y. 
 If Y is a list of arrays, a different color will be used for each of them.