Detail: Yarn: Display#

Overview: Yarn: Display

Yarn.interface#

A Frame documenting the interface of this class.

>>> y = sf.Yarn.from_buses((sf.Bus.from_frames((sf.Frame(np.arange(6).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='x'), sf.Frame((np.arange(6).reshape(3,2) % 2).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='y')), name='i'), sf.Bus.from_frames((sf.Frame(np.arange(40, 46).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='v'), sf.Frame((np.arange(6).reshape(3,2) % 3).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='w')), name='j')), retain_labels=True)
>>> y
<Yarn>
<IndexHierarchy>
i                x     Frame
i                y     Frame
j                v     Frame
j                w     Frame
<<U1>            <<U1> <object>
>>> y.interface
<Frame>
<Index>                              cls_name group                doc                  <<U18>
<Index: signature>
__init__(series, /, *, index, index… Yarn     Constructor          Args: series: An it…
from_buses(buses, /, *, name, retai… Yarn     Constructor          Return a Yarn from …
from_concat(containers, /, *, index… Yarn     Constructor          Concatenate multipl…
to_manifest(fp, /, *, label_encoder) Yarn     Exporter             Write each containe…
to_series()                          Yarn     Exporter             Return a Series wit…
to_sqlite(fp, /, *, config)          Yarn     Exporter             Write the complete …
to_visidata()                        Yarn     Exporter             Open an interactive…
to_xlsx(fp, /, *, config)            Yarn     Exporter             Write the complete …
to_zip_csv(fp, /, *, config, compre… Yarn     Exporter             Write the complete …
to_zip_npy(fp, /, *, config, compre… Yarn     Exporter             Write the complete …
to_zip_npz(fp, /, *, config, compre… Yarn     Exporter             Write the complete …
to_zip_parquet(fp, /, *, config, co… Yarn     Exporter             Write the complete …
to_zip_pickle(fp, /, *, config, com… Yarn     Exporter             Write the complete …
to_zip_tsv(fp, /, *, config, compre… Yarn     Exporter             Write the complete …
STATIC                               Yarn     Attribute            Returns True when t…
dtype                                Yarn     Attribute            Return the dtype of…
dtypes                               Yarn     Attribute            Returns a Frame of …
…                                    …        …                    …
iter_element_items().apply_iter_ite… Yarn     Iterator             Apply a function to…
iter_element_items().apply_pool(fun… Yarn     Iterator             Apply a function to…
via_hashlib(*, include_name, includ… Yarn     Accessor Hashlib     Return the byte sig…
via_hashlib(*, include_name, includ… Yarn     Accessor Hashlib
via_hashlib(*, include_name, includ… Yarn     Accessor Hashlib
via_hashlib(*, include_name, includ… Yarn     Accessor Hashlib
via_hashlib(*, include_name, includ… Yarn     Accessor Hashlib
via_hashlib(*, include_name, includ… Yarn     Accessor Hashlib
via_hashlib(*, include_name, includ… Yarn     Accessor Hashlib
via_hashlib(*, include_name, includ… Yarn     Accessor Hashlib
via_hashlib(*, include_name, includ… Yarn     Accessor Hashlib
via_hashlib(*, include_name, includ… Yarn     Accessor Hashlib
via_type_clinic.to_hint()            Yarn     Accessor Type Clinic Return the type hin…
via_type_clinic.check(hint, /, *, f… Yarn     Accessor Type Clinic Given a hint (a typ…
via_type_clinic.warn(hint, /, *, fa… Yarn     Accessor Type Clinic Given a hint (a typ…
via_type_clinic.__call__(hint, /, *… Yarn     Accessor Type Clinic Given a hint (a typ…
via_type_clinic.__repr__()           Yarn     Accessor Type Clinic Return a compact st…
<<U91>                               <<U4>    <<U20>               <<U81>
Yarn.__repr__()#

Return repr(self).

>>> y = sf.Yarn.from_buses((sf.Bus.from_frames((sf.Frame(np.arange(6).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='x'), sf.Frame((np.arange(6).reshape(3,2) % 2).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='y')), name='i'), sf.Bus.from_frames((sf.Frame(np.arange(40, 46).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='v'), sf.Frame((np.arange(6).reshape(3,2) % 3).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='w')), name='j')), retain_labels=True)
>>> repr(y)
<Yarn>
<IndexHierarchy>
i                x     Frame
i                y     Frame
j                v     Frame
j                w     Frame
<<U1>            <<U1> <object>
Yarn.__str__()#

Return str(self).

>>> y = sf.Yarn.from_buses((sf.Bus.from_frames((sf.Frame(np.arange(6).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='x'), sf.Frame((np.arange(6).reshape(3,2) % 2).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='y')), name='i'), sf.Bus.from_frames((sf.Frame(np.arange(40, 46).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='v'), sf.Frame((np.arange(6).reshape(3,2) % 3).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='w')), name='j')), retain_labels=True)
>>> str(y)
<Yarn>
<IndexHierarchy>
i                x     Frame
i                y     Frame
j                v     Frame
j                w     Frame
<<U1>            <<U1> <object>
Yarn.display(config=None, /, *, style_config=None)[source]#

Return a static_frame.Display, capable of providing a string representation.

Parameters:

config – A static_frame.DisplayConfig instance. If not provided, the static_frame.DisplayActive will be used.

>>> y = sf.Yarn.from_buses((sf.Bus.from_frames((sf.Frame(np.arange(6).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='x'), sf.Frame((np.arange(6).reshape(3,2) % 2).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='y')), name='i'), sf.Bus.from_frames((sf.Frame(np.arange(40, 46).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='v'), sf.Frame((np.arange(6).reshape(3,2) % 3).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='w')), name='j')), retain_labels=True)
>>> y.display()
<Yarn>
<IndexHierarchy>
i                x     Frame
i                y     Frame
j                v     Frame
j                w     Frame
<<U1>            <<U1> <object>
>>> y.display(sf.DisplayConfig(type_show=False))
i x Frame
i y Frame
j v Frame
j w Frame
Yarn.display_tall(config=None, /)#

Maximize vertical presentation. Return a static_frame.Display, capable of providing a string representation.

Parameters:

config – A static_frame.DisplayConfig instance. If not provided, the static_frame.DisplayActive will be used.

>>> y = sf.Yarn.from_buses((sf.Bus.from_frames((sf.Frame(np.arange(6).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='x'), sf.Frame((np.arange(6).reshape(3,2) % 2).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='y')), name='i'), sf.Bus.from_frames((sf.Frame(np.arange(40, 46).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='v'), sf.Frame((np.arange(6).reshape(3,2) % 3).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='w')), name='j')), retain_labels=True)
>>> y.display_tall()
<Yarn>
<IndexHierarchy>
i                x     Frame
i                y     Frame
j                v     Frame
j                w     Frame
<<U1>            <<U1> <object>
Yarn.display_wide(config=None, /)#

Maximize horizontal presentation. Return a static_frame.Display, capable of providing a string representation.

Parameters:

config – A static_frame.DisplayConfig instance. If not provided, the static_frame.DisplayActive will be used.

>>> y = sf.Yarn.from_buses((sf.Bus.from_frames((sf.Frame(np.arange(6).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='x'), sf.Frame((np.arange(6).reshape(3,2) % 2).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='y')), name='i'), sf.Bus.from_frames((sf.Frame(np.arange(40, 46).reshape(3,2), index=('p', 'q', 'r'), columns=('a', 'b'), name='v'), sf.Frame((np.arange(6).reshape(3,2) % 3).astype(bool), index=('p', 'q', 'r'), columns=('c', 'd'), name='w')), name='j')), retain_labels=True)
>>> y.display_wide()
<Yarn>
<IndexHierarchy>
i                x     Frame
i                y     Frame
j                v     Frame
j                w     Frame
<<U1>            <<U1> <object>

Yarn: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Accessor Hashlib | Accessor Type Clinic | Accessor Mapping