sgkit.display_pedigree#
- sgkit.display_pedigree(ds, parent='parent', graph_attrs=None, node_attrs=None, edge_attrs=None)#
Display a pedigree dataset as a directed acyclic graph.
- Parameters:
- ds
Dataset Dataset containing pedigree structure.
- parent
Hashable(default:'parent') Input variable name holding parents of each sample as defined by
sgkit.variables.parent_spec. If the variable is not present inds, it will be computed usingparent_indices().- graph_attrs {
Hashable:str} |NoneOptional[Dict[Hashable,str]] (default:None) Key-value pairs to pass through to graphviz as graph attributes.
- node_attrs {
Hashable:ndarray|Array} |NoneOptional[Dict[Hashable,Union[ndarray,Array]]] (default:None) Key-value pairs to pass through to graphviz as node attributes. Values will be broadcast to have shape (samples, ).
- edge_attrs {
Hashable:ndarray|Array} |NoneOptional[Dict[Hashable,Union[ndarray,Array]]] (default:None) Key-value pairs to pass through to graphviz as edge attributes. Values will be broadcast to have shape (samples, parents).
- ds
- Raises:
RuntimeError – If the Graphviz library is not installed.
- Return type:
- Returns:
: A digraph representation of the pedigree.