rstoolbox.components.DesignFrame.get_id¶

DesignFrame.get_id()¶

Return identifier data for the design(s).

Returns:

str or Series - depending on the input

Raises:

TypeError:	if the data container is not `DataFrame` or `Series`
KeyError:	If the column `description` cannot be found.

Example

In [1]: from rstoolbox.io import parse_rosetta_file
   ...: import pandas as pd
   ...: pd.set_option('display.width', 1000)
   ...: pd.set_option('display.max_columns', 500)
   ...: df = parse_rosetta_file("../rstoolbox/tests/data/input_2seq.minisilent.gz")
   ...: df.get_id()
   ...: 
Out[1]: 
0    test_3lhp_binder_labeled_00001
1    test_3lhp_binder_labeled_00002
2    test_3lhp_binder_labeled_00003
3    test_3lhp_binder_labeled_00004
4    test_3lhp_binder_labeled_00005
5    test_3lhp_binder_labeled_00006
Name: description, dtype: object