Flux Balance Analysis Result
FBAResult class.
A resource set object containing the result tables of a flux balance analysis.
Views
Functions
Constructor, please do not overwrite this method, use the init method instead Leave the constructor without parameters.
| Name | Type | Default value | Description |
|---|---|---|---|
| flux_dataframe | DataFrame | None | |
| sv_dataframe | DataFrame | None |
Add a resource to the set
can be retrieve by calling the get_resource method with the name. If not provided, the resource name is used Otherwise it doesn't create a new resource but references it. In this case the resource must be an input of the task that created the ResourceSet and the resource must have been saved before, defaults to True
| Name | Type | Default value | Description |
|---|---|---|---|
| resource | Resource | Resource to add | |
| unique_name | str | None | Name used to store the resource in the dict. it must be unique. the resource |
| create_new_resource | bool | True | If true, a new resource is created when saving the resource. , optional |
Add technical information on the resource. Technical info are useful to set additional information on the resource.
| Name | Type | Default value | Description |
|---|---|---|---|
| technical_info | TechnicalInfo | Technical information to add (key, value) |
You can redefine this method to define custom logic to check this resource. If there is a problem with the resource, return a string that define the error, otherwise return None This method is called on output resources of a task. If there is an error returned, the task will be set to error and next proceses will not be run. It is also call when uploading a resource (usually for files or folder), if there is an error returned, the resource will not be uploaded
Union[str, NoneType] |
Clone the resource to create a new instance with a new id. It copies the RFields.
ResourceType |
Compute the zero-flux threshold
(<class 'float'>, <class 'float'>) |
You can redefine this method to set a name of the resource. When saving the resource the name will be saved automatically This can be useful to distinguish this resource from another one or to search for the resource
str |
Get flux values by reaction ids
| Name | Type | Default value | Description |
|---|---|---|---|
| reaction_ids | Union[typing.List, str] |
DataFrame |
Get the flux table
Get fluxes as dataframe
DataFrame |
| Name | Type | Default value | Description |
|---|---|---|---|
| resource_name | str |
Resource |
Set |
List |
Dict |
Set |
Get SV values by compound ids
| Name | Type | Default value | Description |
|---|---|---|---|
| compound_ids | Union[typing.List, str] |
DataFrame |
Get SV as dataframe
DataFrame |
Get the SV table
Get the technical information of the resource
| Name | Type | Default value | Description |
|---|---|---|---|
| key | str | Key of the technical information |
TechnicalInfo |
This can be overwritten to perform custom initialization of the resource. This method is called just after the init (constructor) of the resource. The default values of RFields are set before this method is called.
| Name | Type | Default value | Description |
|---|---|---|---|
| resource_name | str |
Resource |