booldog.classes

Plain dataclasses used throughout booldog: BoolDogNode (a single node’s identifier/name/rule) and BoolDogModelInfo (model metadata). A booldog.network.BoolDogModel network is fundamentally a dict of BoolDogNode objects, keyed by identifier.

Classes

BoolDogNode	A dataclass to represent a node in a Boolean network.
BoolDogModelInfo	A dataclass to represent metadata about a Boolean network model.

Module Contents

class booldog.classes.BoolDogNode

A dataclass to represent a node in a Boolean network.

identifier: str

The identifier of the node.

rule: str

The Boolean rule of the node in Bnet format.

name: str | None = None

The (optional) name of the node. Defaults to identifier if not given.

__post_init__()

Default name to identifier if name was not given (falsy).

__repr__()

String representation showing the node’s name and rule.

class booldog.classes.BoolDogModelInfo

A dataclass to represent metadata about a Boolean network model.

identifier: str | None = None

The identifier of the model. Defaults to “BoolDogModel” if not given (falsy). Set to the model’s own id by some readers (e.g. the SBML-qual reader sets this to the SBML model id); used e.g. to title Cytoscape exports.

source: str | None = None

The source of the model (e.g., file name, database, etc.).

source_format: str | None = None

The exchange format the model was read from (e.g. “bnet”, “primes”, “sbml-qual”), as recorded by the corresponding booldog.io reader.

notes: str | None = None

Free-text notes about the model. Not currently set or read anywhere else in the package.

__post_init__()

Default identifier to “BoolDogModel” if not given (falsy).

__repr__()

String representation showing the model’s identifier and source.