CTRL + K
Apps
Stories
Agents
Bricks
Constellab Space LogoSpace
Login
Back to bricks list
Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

Table

RESOURCE
Typing name :  RESOURCE.gws_core.Table Brick :  gws_core
Parent :
Resource

2d excel like table

Main 2d table with named columns and rows. It is a wrapper of the pandas Dataframe, to access it use the get_data() method.

Tags

In additions, a Table has tags (metadata) for each column and row. A tag is a dictionary of key-value pairs. It is helpful to add information about the data in the table for a row or a column. Tags are visible in the interface and can be used to manipulate (filter, merge...) the data.

Header names

Table has more strict rules about row and column names than DataFrame :

  • Row names are converted to string and must be unique (if not, _1, _2, _3, ... are added to the name)
  • Column names are converted to string and must be unique (if not, _1, _2, _3, ... are added to the name)
Views
TABULARDefault view
View as a table
SMART INTERACTIVE PLOT
Generate an interactive plot using an AI (OpenAI).
VIEW RESOURCE
View the complete resource as json
Attributes
comments: strflagged: boolname: strstyle: TypingStyletags: TagListtechnical_info: TechnicalInfoDictuid: str
Functions
__INIT__

Create a new Table

data : Union
data use to initilialize the table
row_names : List
set the row names for the table. Must be the same size as the number of rows
column_names : List
set the column names for the table. Must be the same size as the number of columns
row_tags : List
set the row tags for the table. Must be the same size as the number of rows
column_tags : List
set the column tags for the table. Must be the same size as the number of columns
strict_format_header_names : bool - False
If false, the following rules are applied to headers (columns and rows) names: - convert to string - remove leading and trailing whitespaces - rename duplicates by adding _1, _2, _3, ... at the end of the name If true, the previous rules apply plus : - replace ' ', '-', '.' with underscores - remove all other special characters - remove all accents
ADD_COLUMN

Add a new column to the Dataframe.

Name : str
name of the column
data : Union
data for the column, must be the same length as other colums
index : int
index for the column, if none, the column is append to the end
ADD_COLUMN_TAG_BY_INDEX

Add a tag to a column at a given index

column_index : int
index of the column
key : str
key of the tag
value : str
value of the tag
ADD_COLUMN_TAG_BY_NAME

Add a tag to a column by name

column_name : str
name of the column
key : str
key of the tag
value : str
value of the tag
ADD_ROW

Add a row to the Dataframe.

Name : str
name of the row
data : Union
data of the row
index : int
index of the row, if none, the row is append to the end
ADD_ROW_TAG_BY_INDEX

Add a tag to a row at a given index

row_index : int
index of the row
key : str
key of the tag
value : str
value of the tag
ADD_ROW_TAG_BY_NAME

Add a tag to a row by name

row_name : str
name of the row
key : str
key of the tag
value : str
value of the tag
ADD_TECHNICAL_INFO

Add technical information on the resource. Technical info are useful to set additional information on the resource.

technical_info : TechnicalInfo
technical information to add (key, value) this is a long description of the technical information
CHECK_COLUMN_EXISTS

Checks if a column with the given name exists in the Table and raises an exception if it doesn't.

Name : str
The name of the column to check.
case_sensitive : bool - True
Whether the check should be case sensitive. Defaults to True.
CHECK_RESOURCE

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

Return type : Optional
CHECK_ROW_EXISTS

Checks if a row with the given name exists in the Table and raises an exception if it doesn't.

Name : str
The name of the row to check.
case_sensitive : bool - True
Whether the check should be case sensitive. Defaults to True.
CLONE

Clone the resource to create a new instance with a new id. It copies the RFields.

Return type : ResourceType
COLUMN_EXISTS

Checks if a column with the given name exists in the Table.

Name : str
The name of the column to check.
case_sensitive : bool - True
Whether the check should be case sensitive. Defaults to True.
Return type : bool
COPY_COLUMN_TAGS_BY_INDEX

Copy column tags from source_table to self matching by index.

source_table : Table
source table to copy tags from
from_index : int
start index of the columns to copy
to_index : int
end index of the columns to copy
COPY_COLUMN_TAGS_BY_NAME

Copy column tags from source_table to self matching by name.

source_table : Table
source table to copy tags from
COPY_ROW_TAGS_BY_INDEX

Copy row tag from source_table to self matching by index

source_table : Table
source table to copy tags from
from_index : int
start index of the rows to copy
to_index : int
end index of the rows to copy
COPY_ROW_TAGS_BY_NAME

Copy row tag from source_table to self matching by name

source_table : Table
source table to copy tags from
CREATE_SUB_TABLE

Create a new table from a dataframe and a meta

dataframe : DataFrame
The dataframe
row_tags : List
The list of row tags
column_tags : List
The list of column tags
Return type : Table
CREATE_SUB_TABLE_FILTERED_BY_COLUMNS

Create a sub Table based on a subset Dataframe of this original table filtered by columns It copies the tags of this table into the new table based on column names that matched between filtered_df and this dataframe.

filtered_df : DataFrame
The filtered dataframe
Return type : Table
CREATE_SUB_TABLE_FILTERED_BY_ROWS

Create a sub Table based on a subset Dataframe of this original table filtered by rows. It copies the tags of this table into the new table based on row names that matched between filtered_df and this dataframe.

filtered_df : DataFrame
The filtered dataframe
Return type : Table
EQUALS

Check if the table is equal to another table. It compares the data, row tags and column tags.

o : object
The other table
Return type : bool
EXTRACT_COLUMN_TAGS_TO_NEW_ROW

Create a new row and fill it with the values of the tag of each column.

tag_key : str
new_row_name : str
name of the new row that will contains tag values. If none, tag key is used as name
EXTRACT_COLUMN_VALUES_TO_ROW_TAGS

Create a new tag for each row and fill it with the values of the provided column

column_name : str
name of the column to extract
new_tag_key : str
key of the new tag that will contains column values. If none, column name is used as key
delete_column : bool - False
if true, delete the column after the extraction
EXTRACT_ROW_TAGS_TO_NEW_COLUMN

Create a new columns and fill it with the values of the tag of each row

tag_key : str
new_column_name : str
name of the new column that will contains tag values. If none, tag key is used as name
EXTRACT_ROW_VALUES_TO_COLUMN_TAGS

Create a new tag for each column and fill it with the values of the row.

row_name : str
name of the row to extract values from
new_tag_key : str
key of the new tag that will contains row values. If none, row name is used as key
delete_row : bool - False
if true, delete the row after the extraction
FILTER_OUT_BY_COLUMN_NAMES

Filter out table columns matching a list of names, return a new table

filters : List
The list of names
Return type : Table
FILTER_OUT_BY_ROW_NAMES

Filter out table rows matching a list of names, return a new table

filters : List
The list of names
Return type : Table
FILTER_OUT_BY_TAGS

Filter out table rows or columns matching a list of tags and return a new table. The row or column that matches the tags are removed.

Example of search tags are:

  • tags = [ {"key1": "value1"} ] to filter out rows or columns having a tag {"key1": "value1"}
  • tags = [ {"key1": "value1", "key2": "value2"} ] to filter out rows or columns having tags {"key1": "value1"} AND {"key2": "value2"}
  • tags = [ {"key1": "value1"}, {"key2": "value2"} ] to filter out rows or columns having tags {"key1": "value1"} OR {"key2": "value2"}
  • tags = [ {"key1": "value1", "key2": "value2"}, {"key3": "value3"} ] to filter out rows or columns having tags ({"key1": "value1"} AND {"key2": "value2"}) OR {"key2": "value2"}
  • AND and OR logics can further be combined to perform complex selects
axis : Literal
axis to filter out the tags
tags : List
The of tags
Return type : Table
GENERATE_NEW_COLUMN_NAME

Generates a column name that is unique in the Dataframe base on name. If the column name doesn't exist, return name, otherwise return name_1 or name_2, ... Only the name is returned, the column is not added to the Dataframe.

Name : str
name of the column
Return type : str
GET_AVAILABLE_COLUMN_TAGS

Get the available tags for each column.

Return type : Dict
GET_AVAILABLE_ROW_TAGS

Get the available tags for each row.

Return type : Dict
GET_CELL_VALUE_AT

Get the value of a cell at a given coordonate (row, column)

row_index : int
index of the row
column_index : int
index of the column
Return type : Any
GET_COLUMN_AS_DATAFRAME

Returns a column with the given name as a DataFrame.

column_name : str
The name of the column.
skip_nan : bool - False
Whether to skip NaN values. Defaults to False.
Return type : DataFrame
GET_COLUMN_DATA

Returns the data of a column with the given name.

column_name : str
The name of the column.
skip_nan : bool - False
Whether to skip NaN values. Defaults to False.
Return type : List
GET_COLUMN_INDEX_FROM_NAME

Get the index of a column from its name

column_name : str
name of the column
Return type : int
GET_COLUMN_INFO

Get the info of a column by name

column_name : str
name of the column
Return type : TableColumnInfo
GET_COLUMN_NAMES

Get the column names

from_index : int
start index of the columns to retrieve
to_index : int
end index of the columns to retrieve
Return type : List
GET_COLUMN_NAMES_BY_INDEXES

Function to retrieve the column names based on column indexes

indexes : List
list of column indexes
Return type : List
GET_COLUMN_TAGS

Get the tags of multiple columns by index

from_index : int
start index of the columns to retrieve
to_index : int
end index of the columns to retrieve, to_index is included
none_if_empty : bool - False
if true, return None if no tags are found
Return type : List
GET_COLUMN_TAGS_BY_INDEX

Get the tags of a column at a given index

column_index : int
index of the column
Return type : Dict
GET_COLUMN_TAGS_BY_NAME

Get the tags of a column by name

column_name : str
name of the column
Return type : Dict
GET_COLUMN_TYPE

Get the type of a column

column_name : Any
name of the column
Return type : TableColumnType
GET_COLUMNS_INFO

Get the info of multiple columns by index

from_index : int
start index of the columns to retrieve
to_index : int
end index of the columns to retrieve
Return type : List
GET_DATA
Return type : DataFrame
GET_DEFAULT_NAME

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

Return type : str
GET_DEFAULT_STYLE

Get the default style of the resource

Return type : TypingStyle
GET_MODEL_ID

Get the id of the resource model in the database. It is provided by the system for input resources of a task.

Return type : str
GET_NAME_OR_DEFAULT

Get the name of the resource or the default name if the name is None

Return type : str
GET_ROW_DATA

Returns the data of a row with the given name.

row_name : str
The name of the row.
skip_na : bool - False
Whether to skip NaN values. Defaults to False.
Return type : List
GET_ROW_INDEX_BY_NAME

Get the index of a row from its name. Raise an exception if the row doesn't exist

row_name : str
name of the row
Return type : int
GET_ROW_INFO

Get the info of a row by name

row_name : str
name of the row
Return type : TableHeaderInfo
GET_ROW_NAMES

Get the row names of the table by index

from_index : int
start index of the rows to retrieve
to_index : int
end index of the rows to retrieve
Return type : List
GET_ROW_NAMES_BY_INDEXES

Function to retrieve the row names based on row indexes

indexes : List
list of row indexes
Return type : List
GET_ROW_TAG_BY_NAME

Get the tags of a row by name

row_name : str
name of the row
Return type : Dict
GET_ROW_TAGS

Get the tags of multiple rows by index

from_index : int
start index of the rows to retrieve
to_index : int
end index of the rows to retrieve, to_index is included
none_if_empty : bool - False
if true, return None if no tags are found
Return type : List
GET_ROW_TAGS_BY_INDEX

Get the tags of a row at a given index

row_index : int
index of the row
Return type : Dict
GET_ROWS_INFO

Get the info of multiple rows by index

from_index : int
start index of the rows to retrieve
to_index : int
end index of the rows to retrieve
Return type : List
GET_TAGS

Get the tags of a given axis

axis : Literal
axis to retrieve the tags
Return type : List
GET_TECHNICAL_INFO

Get the technical information of the resource

key : str
key of the technical information
Return type : TechnicalInfo
INFER_OBJECTS

Call infer_objects on the underlying dataframe, it modifies the table dataframe.

Return type : Table
INIT

This can be overwritten to perform custom initialization of the resource. This method is called after the init (constructor) of the resource. The values of RFields are set when this method is called.

REMOVE_COLUMN

Remove a column from the Dataframe.

column_name : str
name of the column
REMOVE_ROW

Remove a row from the Dataframe.

row_name : str
name of the row to remove
ROW_EXISTS

Checks if a row with the given name exists in the Table.

Name : str
The name of the row to check.
case_sensitive : bool - True
Whether the check should be case sensitive. Defaults to True.
Return type : bool
SELECT_BY_COLUMN_INDEXES

Select table columns matching a list of indexes, return a new table

indexes : List
The list of indexes
Return type : Table
SELECT_BY_COLUMN_NAMES

Select table columns matching a list of names, return a new table

filters : List
The list of names
Return type : Table
SELECT_BY_COLUMN_TAGS

Select table columns matching a list of tags

Example of search tags are:

  • tags = [ {"key1": "value1"} ] to select columns having a tag {"key1": "value1"}
  • tags = [ {"key1": "value1", "key2": "value2"} ] to select columns having tags {"key1": "value1"} AND {"key2": "value2"}
  • tags = [ {"key1": "value1"}, {"key2": "value2"} ] to select columns having tags {"key1": "value1"} OR {"key2": "value2"}
  • tags = [ {"key1": "value1", "key2": "value2"}, {"key3": "value3"} ] to select columns having tags ({"key1": "value1"} AND {"key2": "value2"}) OR {"key2": "value2"}
  • AND and OR logics can further be combined to perform complex selects
tags : List
The of tags
Return type : Table
SELECT_BY_COORDS

Create a new table from coords. It does not includes the to_row_id and to_column_id

from_row_id : int
start row index
from_column_id : int
start column index
to_row_id : int
end row index
to_column_id : int
end column index
Return type : Table
SELECT_BY_ROW_INDEXES

Select table rows matching a list of indexes, return a new table

indexes : List
The list of indexes
Return type : Table
SELECT_BY_ROW_NAMES

Select table rows matching a list of names, return a new table

filters : List
The list of names
Return type : Table
SELECT_BY_ROW_TAGS

Select table rows matching a list of tags

Example of search tags are:

  • tags = [ {"key1": "value1"} ] to select rows having a tag {"key1": "value1"}
  • tags = [ {"key1": "value1", "key2": "value2"} ] to select rows having tags {"key1": "value1"} AND {"key2": "value2"}
  • tags = [ {"key1": "value1"}, {"key2": "value2"} ] to select rows having tags {"key1": "value1"} OR {"key2": "value2"}
  • tags = [ {"key1": "value1", "key2": "value2"}, {"key3": "value3"} ] to select rows having tags ({"key1": "value1"} AND {"key2": "value2"}) OR {"key2": "value2"}
  • AND and OR logics can further be combined to perform complex selects
tags : List
The of tags
Return type : Table
SELECT_BY_TAGS

Select table rows or columns matching a list of tags and return a new table

Example of search tags are:

  • tags = [ {"key1": "value1"} ] to select rows or columns having a tag {"key1": "value1"}
  • tags = [ {"key1": "value1", "key2": "value2"} ] to select rows or columns having tags {"key1": "value1"} AND {"key2": "value2"}
  • tags = [ {"key1": "value1"}, {"key2": "value2"} ] to select rows or columns having tags {"key1": "value1"} OR {"key2": "value2"}
  • tags = [ {"key1": "value1", "key2": "value2"}, {"key3": "value3"} ] to select rows or columns having tags ({"key1": "value1"} AND {"key2": "value2"}) OR {"key2": "value2"}
  • AND and OR logics can further be combined to perform complex selects
axis : Literal
axis to select the tags
tags : List
The of tags
Return type : Table
SELECT_NUMERIC_COLUMNS

Select only numeric columns, return a new table

drop_na : Literal - all
if drop_na = 'all', then drops columns where all values are nan (similar to `DataFrame.drop_na(how=all|any)`) if drop_na = 'any', then drop columns where any values are nan (similar to `DataFrame.drop_na(how=all|any)`)
Return type : Table
SET_ALL_COLUMN_NAMES

Set the names of all columns

column_names : List
list of column names
SET_ALL_COLUMN_TAGS

Set the tags of all columns, the length of the list must be equal to the number of columns

tags : List
list of tags
SET_ALL_ROW_NAMES

Set the names of all rows

row_names : List
list of row names, must be the same length number of rows
SET_ALL_ROW_TAGS

Set the tags of all rows, the length of the list must be equal to the number of rows

tags : List
list of tags
SET_CELL_VALUE_AT

Set the value of a cell at a given coordonate (row, column)

row_index : int
index of the row
column_index : int
index of the column
value : Any
value to set
SET_COLUMN_NAME

Set the name of a column at a given index

current_name : str
current name of the column
new_name : str
new name of the column
SET_COLUMN_TAGS_BY_INDEX

Set the tags of a column at a given index

column_index : int
index of the column
tags : Dict
tags to set
SET_COLUMN_TAGS_BY_NAME

Set the tags of a column by name

column_name : str
name of the column
tags : Dict
tags to set
SET_COMMENTS
Comments : str - ''
SET_ROW_NAME

Update the name of a row

current_name : Any
current name of the row
new_name : str
new name of the row
SET_ROW_TAGS_BY_INDEX

Set the tags of a row at a given index

row_index : int
index of the row
tags : Dict
tags to set
SET_ROW_TAGS_BY_NAME

Set the tags of a row by name

row_name : str
name of the row
tags : Dict
tags to set
TAIL

Returns the last n rows for the columns ant targets.

nrows : int - 5
Number of rows
Return type : DataFrame
TO_CSV

Returns the table as a csv string.

Return type : str
TO_DATAFRAME

Returns the table as a pandas dataframe.

Return type : DataFrame
TO_JSON

Returns the table as a json string.

Return type : dict
TO_LIST

Returns the table as a list of lists.

Return type : List
TO_NUMPY

Returns the table as a numpy array.

Return type : ndarray
TRANSPOSE

Transpose the table, it returnes a new Table, the original table is not modified.

infer_objects : bool - False
Return type : Table
VIEW_AS_BAR_PLOT

View one or several columns as bar plots

params : ConfigParams
Return type : TableBarPlotView
VIEW_AS_BOX_PLOT

View one or several columns as box plots

params : ConfigParams
Return type : TableBoxPlotView
VIEW_AS_HEATMAP

View the table as heatmap

params : ConfigParams
Return type : TableHeatmapView
VIEW_AS_HISTOGRAM

View columns as 2D-line plots

params : ConfigParams
Return type : TableHistogramView
VIEW_AS_LINE_PLOT_2D

View columns as 2D-line plots

params : ConfigParams
Return type : TableLinePlot2DView
VIEW_AS_SCATTER_PLOT_2D

View one or several columns as 2D-line plots

params : ConfigParams
Return type : TableScatterPlot2DView
VIEW_AS_STACKED_BAR_PLOT

View one or several columns as 2D-stacked bar plots

params : ConfigParams
Return type : TableStackedBarPlotView
VIEW_AS_VENN_DIAGRAM

View the table as Venn diagram

params : ConfigParams
Return type : TableVennDiagramView
VIEW_AS_VULCANO_PLOT
params : ConfigParams
Return type : TableVulcanoPlotView
CLASSNAME - @classmethod

Returns the name of the class

slugify : bool - False
True to slugify the class name if True
snakefy : bool - False
True to snakefy the class name if True
replace_uppercase : bool - False
Replace upper cases by "-" if True
Return type : str
COPY_STYLE - @classmethod

Copy the style of the resource with the possibility to override some properties. Useful when settings the style for a task based on the resource style.

Icon technical name : str
technical name of the icon if provided, the icon_type must also be provided
Icon type : TypingIconType
type of the icon if provided, the icon_technical_name must also be provided
background_color : str
background color
icon_color : TypingIconColor
icon color
Return type : TypingStyle
FROM_DICT - @classmethod
data : dict
orient : str - index
dtype : Any
columns : Any
Return type : Table
FULL_CLASSNAME - @classmethod

Returns the full name of the class

slugify : bool - False
Slugify the returned class name if True
snakefy : bool - False
Snakefy the returned class name if True
Return type : str
GET_HUMAN_NAME - @classmethod

Get the human name of the resource

Return type : str
GET_SHORT_DESCRIPTION - @classmethod

Get the short description of the resource

Return type : str
GET_STYLE - @classmethod

Get the style of the resource

Return type : TypingStyle
GET_TYPING_NAME - @classmethod

Get the typing name of the resource

Return type : str
INHERITORS - @classmethod

Get all the classes that inherit this class

Return type : List