ngcloud.info module

class ngcloud.info.Sample(name, pair_end=None, stranded=None)

Sample experiment run information.

Parameters:

name : string

pair_end : {‘R1’, ‘R2’, False}, optional

stranded : bool, optional

Examples

If a sample is pair-end, say sample 5566 has read 1 and 2, then one should explicitly creates two Sample instances

>>> pe = [Sample(name='5566' % pe, pair_end=pe) for pe in ['R1', 'R2']]
>>> pe
[Sample(name='5566'), Sample(name='5566')]
>>> print(pe[0])  # get first pair-end sample
Sample 5566
    pair_end: R1
    stranded: None

>>> pe[0].full_name
'5566_R1'

Attributes

name	(string) Sample name. Pair-end samples should have same name
full_name	(string) Auto-generated full sample name, containing pair-end info.

class ngcloud.info.JobInfo(root_path)

Store a job information.

Parameters:root_path : path like object

Attributes

id	(str)
type	(str)
sample_list	(list) Lists of Sample in this job