Yarn

Detail: Yarn

Yarn: Constructor

Detail: Yarn: Constructor

Detail

Yarn.__init__(series, *, index, index_constructor, deepcopy_from_bus, hierarchy, own_index)

Args: series: An iterable (or Series) of Bus. The length of this container is no…

Detail

Yarn.from_buses(buses, *, name, retain_labels, deepcopy_from_bus)

Return a Yarn from an iterable of Bus; labels will be drawn from Bus.name.

Detail

Yarn.from_concat(containers, *, index, name, deepcopy_from_bus)

Concatenate multiple Bus into a new Yarn. Loaded status of Frame within each Bus…

Yarn: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Yarn: Exporter

Detail: Yarn: Exporter

Detail

Yarn.to_hdf5(fp, *, config)

Write the complete Bus as an HDF5 table. Args: fp: A string file path or Path in…

Detail

Yarn.to_series()

Return a Series with the Frame contained in all contained Bus.

Detail

Yarn.to_sqlite(fp, *, config)

Write the complete Bus as an SQLite database file. Args: fp: A string file path…

Detail

Yarn.to_visidata()

Open an interactive VisiData session.

Detail

Yarn.to_xlsx(fp, *, config)

Write the complete Bus as a XLSX workbook. Args: fp: A string file path or Path…

Detail

Yarn.to_zip_csv(fp, *, config)

Write the complete Bus as a zipped archive of CSV files. Args: fp: A string file…

Detail

Yarn.to_zip_parquet(fp, *, config)

Write the complete Bus as a zipped archive of parquet files. Args: fp: A string…

Detail

Yarn.to_zip_pickle(fp, *, config)

Write the complete Bus as a zipped archive of pickles. Args: fp: A string file p…

Detail

Yarn.to_zip_tsv(fp, *, config)

Write the complete Bus as a zipped archive of TSV files. Args: fp: A string file…

Yarn: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Yarn: Attribute

Detail: Yarn: Attribute

Detail

Yarn.STATIC

bool(x) -> bool Returns True when the argument x is true, False otherwise. The b…

Detail

Yarn.dtype

Return the dtype of the realized NumPy array. Returns: numpy.dtype

Detail

Yarn.dtypes

Returns a Frame of dtypes for all loaded Frames.

Detail

Yarn.index

The index instance assigned to this container. Returns: Index

Detail

Yarn.mloc

Returns a Series showing a tuple of memory locations within each loaded Frame.

Detail

Yarn.name

A hashable label attached to this container. Returns: Hashable

Detail

Yarn.nbytes

Total bytes of data currently loaded in Bus contained in this Yarn.

Detail

Yarn.ndim

Return the number of dimensions, which for a Yarn is always 1. Returns: int

Detail

Yarn.shape

Return a tuple describing the shape of the realized NumPy array. Returns: Tuple[…

Detail

Yarn.shapes

A Series describing the shape of each loaded Frame. Unloaded Frame will have a s…

Detail

Yarn.size

Return the size of the underlying NumPy array. Returns: int

Detail

Yarn.status

Return a Frame indicating loaded status, size, bytes, and shape of all loaded Fr…

Yarn: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Yarn: Method

Detail: Yarn: Method

Detail

Yarn.__bool__()

Raises ValueError to prohibit ambiguous use of truethy evaluation.

Detail

Yarn.__len__()

Length of values.

Detail

Yarn.equals(other, *, compare_name, compare_dtype, compare_class, skipna)

Return a bool from comparison to any other object. Note: this will attempt to lo…

Detail

Yarn.head(count)

Return a Yarn consisting only of the top elements as specified by count. Args: c…

Detail

Yarn.rehierarch(depth_map)

Return a new Series with new a hierarchy based on the supplied depth_map.

Detail

Yarn.relabel(index)

Return a new Yarn with transformed labels on the index. The size and ordering of…

Detail

Yarn.relabel_flat()

Return a new Yarn, where an IndexHierarchy (if defined) is replaced with a flat,…

Detail

Yarn.relabel_level_add(level)

Return a new Yarn, adding a new root level to an existing IndexHierarchy, or cre…

Detail

Yarn.relabel_level_drop(count)

Return a new Yarn, dropping one or more levels from a either the root or the lea…

Detail

Yarn.rename(name)

Return a new Yarn with an updated name attribute. Args: name

Detail

Yarn.tail(count)

Return a Yarn consisting only of the bottom elements as specified by count. s Ar…

Detail

Yarn.unpersist()

For the Bus contained in this object, replace all loaded Frame with FrameDeferre…

Yarn: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Yarn: Dictionary-Like

Detail: Yarn: Dictionary-Like

Detail

Yarn.__contains__(value)

Inclusion of value in index labels. Returns: bool

Detail

Yarn.__iter__()

Iterator of index labels, same as Series.keys. Returns: Iterator[Hashasble]

Detail

Yarn.__reversed__()

Returns a reverse iterator on the Yarn index. Returns: Index

Detail

Yarn.get(key, default)

Return the value found at the index key, else the default if the key is not foun…

Detail

Yarn.items()

Iterator of pairs of Yarn label and contained Frame.

Detail

Yarn.keys()

Iterator of index labels. Returns: Iterator[Hashable]

Detail

Yarn.values

A 1D object array of all Frame contained in all contained Bus.

Yarn: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Yarn: Display

Detail: Yarn: Display

Detail

Yarn.interface

A Frame documenting the interface of this class.

Detail

Yarn.__repr__()

Detail

Yarn.__str__()

Return str(self).

Detail

Yarn.display(config, *, style_config)

Return a Display, capable of providing a string representation. Args: config: A…

Detail

Yarn.display_tall(config)

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

Detail

Yarn.display_wide(config)

Maximize horizontal presentation. Return a Display, capable of providing a strin…

Yarn: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Yarn: Selector

Detail: Yarn: Selector

Detail

Yarn.drop[key]

Label-based selection.

Detail

Yarn.drop.iloc[key]

Detail

Yarn.drop.loc[key]

Detail

Yarn[key]

Selector of values by label. Args: key: A loc selector, either a label, a list o…

Detail

Yarn.iloc[key]

Detail

Yarn.loc[key]

Yarn: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Yarn: Iterator

Detail: Yarn: Iterator

Detail

Yarn.iter_element()

Iterator of elements.

Detail

Yarn.iter_element().apply(func, *, dtype, name, index_constructor)

Apply a function to each value. Returns a new container. Args: func: A function…

Detail

Yarn.iter_element().apply_iter(func)

Apply a function to each value. A generator of resulting values. Args: func: A f…

Detail

Yarn.iter_element().apply_iter_items(func)

Apply a function to each value. A generator of resulting key, value pairs. Args:…

Detail

Yarn.iter_element().apply_pool(func, *, dtype, name, index_constructor, max_workers, chunksize, use_threads)

Apply a function to each value. Employ parallel processing with either the Proce…

Detail

Yarn.iter_element().map_all(mapping, *, dtype, name, index_constructor)

Apply a mapping; for values not in the mapping, an Exception is raised. Returns…

Detail

Yarn.iter_element().map_all_iter(mapping)

Apply a mapping; for values not in the mapping, an Exception is raised. A genera…

Detail

Yarn.iter_element().map_all_iter_items(mapping)

Apply a mapping; for values not in the mapping, an Exception is raised. A genera…

Detail

Yarn.iter_element().map_any(mapping, *, dtype, name, index_constructor)

Apply a mapping; for values not in the mapping, the value is returned. Returns a…

Detail

Yarn.iter_element().map_any_iter(mapping)

Apply a mapping; for values not in the mapping, the value is returned. A generat…

Detail

Yarn.iter_element().map_any_iter_items(mapping)

Apply a mapping; for values not in the mapping, the value is returned. A generat…

Detail

Yarn.iter_element().map_fill(mapping, *, fill_value, dtype, name, index_constructor)

Apply a mapping; for values not in the mapping, the fill_value is returned. Retu…

Detail

Yarn.iter_element().map_fill_iter(mapping, *, fill_value)

Apply a mapping; for values not in the mapping, the fill_value is returned. A ge…

Detail

Yarn.iter_element().map_fill_iter_items(mapping, *, fill_value)

Apply a mapping; for values not in the mapping, the fill_value is returned. A ge…

Detail

Yarn.iter_element_items()

Iterator of label, element pairs.

Detail

Yarn.iter_element_items().apply(func, *, dtype, name, index_constructor)

Apply a function to each value. Returns a new container. Args: func: A function…

Detail

Yarn.iter_element_items().apply_iter(func)

Apply a function to each value. A generator of resulting values. Args: func: A f…

Detail

Yarn.iter_element_items().apply_iter_items(func)

Apply a function to each value. A generator of resulting key, value pairs. Args:…

Detail

Yarn.iter_element_items().apply_pool(func, *, dtype, name, index_constructor, max_workers, chunksize, use_threads)

Apply a function to each value. Employ parallel processing with either the Proce…

Detail

Yarn.iter_element_items().map_all(mapping, *, dtype, name, index_constructor)

Apply a mapping; for values not in the mapping, an Exception is raised. Returns…

Detail

Yarn.iter_element_items().map_all_iter(mapping)

Apply a mapping; for values not in the mapping, an Exception is raised. A genera…

Detail

Yarn.iter_element_items().map_all_iter_items(mapping)

Apply a mapping; for values not in the mapping, an Exception is raised. A genera…

Detail

Yarn.iter_element_items().map_any(mapping, *, dtype, name, index_constructor)

Apply a mapping; for values not in the mapping, the value is returned. Returns a…

Detail

Yarn.iter_element_items().map_any_iter(mapping)

Apply a mapping; for values not in the mapping, the value is returned. A generat…

Detail

Yarn.iter_element_items().map_any_iter_items(mapping)

Apply a mapping; for values not in the mapping, the value is returned. A generat…

Detail

Yarn.iter_element_items().map_fill(mapping, *, fill_value, dtype, name, index_constructor)

Apply a mapping; for values not in the mapping, the fill_value is returned. Retu…

Detail

Yarn.iter_element_items().map_fill_iter(mapping, *, fill_value)

Apply a mapping; for values not in the mapping, the fill_value is returned. A ge…

Detail

Yarn.iter_element_items().map_fill_iter_items(mapping, *, fill_value)

Apply a mapping; for values not in the mapping, the fill_value is returned. A ge…

Yarn: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary

Yarn: Operator Binary

Detail: Yarn: Operator Binary

Detail

Yarn.__eq__(value)

Return self==value.

Detail

Yarn.__ge__(value)

Return self>=value.

Detail

Yarn.__gt__(value)

Return self>value.

Detail

Yarn.__le__(value)

Return self<=value.

Detail

Yarn.__lt__(value)

Return self<value.

Detail

Yarn.__ne__(value)

Return self!=value.

Yarn: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary