pandas ------ +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - left operand | | - :xref_param_type:`left` :xref_param_type:`operand` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - right operand | | - :xref_param_type:`right` :xref_param_type:`operand` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - return if cond is False | | - :xref_param_type:`return` :xref_param_type:`if` :xref_param_type:`cond` :xref_param_type:`is` :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - return if cond is True | | - :xref_param_type:`return` :xref_param_type:`if` :xref_param_type:`cond` :xref_param_type:`is` :xref_param_type:`True` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the actual operand | | - :xref_param_type:`the` :xref_param_type:`actual` :xref_param_type:`operand` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame or numpy ndarray-like | | - :xref_param_type:`DataFrame ` or :xref_param_type:`numpy` ndarray-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like | | - :term:`numpy:array_like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of columns, or True, default None | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`columns`, :xref_param_type:`or` :xref_param_type:`True`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object | | - :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple | | - :xref_param_type:`tuple` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'linear', 'log'} | | - {'linear', 'log'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'all', list-like of dtypes or None (default), optional | | - 'all', list-like :xref_param_type:`of` :xref_param_type:`dtypes` or :xref_param_type:`None` (default), optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'backward' (default), 'forward', or 'nearest' | | - 'backward' (default), 'forward', :xref_param_type:`or` 'nearest' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'fixed(f)|table(t)', default is 'fixed' | | - 'fixed(:xref_param_type:`f`)|table(:xref_param_type:`t`)', default :xref_param_type:`is` 'fixed' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'infer', bool-ndarray, 'NaT', default 'raise' | | - 'infer', bool-ndarray, 'NaT', default 'raise' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'property' or 'method' | | - 'property' or 'method' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'raise', 'coerce', default 'raise' | | - 'raise', 'coerce', default 'raise' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'raise','ignore','coerce' | | - 'raise','ignore','coerce' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'skipfooter' was not a non-negative integer. | | - 'skipfooter' :xref_param_type:`was` :xref_param_type:`not` :xref_param_type:`a` non-negative integer. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 'sqlite', default None | | - 'sqlite', default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (float,float), optional | | - (float,float), optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - (legacy) name of DateOffset object to be used, optional | | - (:xref_param_type:`legacy`) :xref_param_type:`name` :xref_param_type:`of` :xref_param_type:`DateOffset` :xref_param_type:`object` :xref_param_type:`to` :xref_param_type:`be` :xref_param_type:`used`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1,2 | | - 1,2 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1d array-like | | - 1d :term:`array-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 1d ndarray or Series | | - 1d :xref_param_type:`ndarray ` or :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 2-d boolean mask | | - 2-d :xref_param_type:`boolean ` :xref_param_type:`mask` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - 2-length sequence (tuple, list, ...) | | - 2-length :term:`python:sequence` (:xref_param_type:`tuple`, :xref_param_type:`list`, ...) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - A 2-tuple where the elements are: | | - :xref_param_type:`A` 2-tuple :xref_param_type:`where` :xref_param_type:`the` :xref_param_type:`elements` are: | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - A tuple (width, height) in inches | | - :xref_param_type:`A` :xref_param_type:`tuple` (:xref_param_type:`width`, :xref_param_type:`height`) :xref_param_type:`in` :xref_param_type:`inches` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - AbstractHolidayCalendar | | - :xref_param_type:`AbstractHolidayCalendar` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - An array for elements x + b for each element x in arr if b is | | - :xref_param_type:`An` :xref_param_type:`array ` :xref_param_type:`for` :xref_param_type:`elements` :xref_param_type:`x` + :xref_param_type:`b` :xref_param_type:`for` :xref_param_type:`each` :xref_param_type:`element` :xref_param_type:`x` :xref_param_type:`in` :xref_param_type:`arr` :xref_param_type:`if` :xref_param_type:`b` :xref_param_type:`is` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - An invalid data type was passed in for w (e.g. dict). | | - :xref_param_type:`An` :xref_param_type:`invalid` :xref_param_type:`data` :xref_param_type:`type` :xref_param_type:`was` :xref_param_type:`passed` :xref_param_type:`in` :xref_param_type:`for` :xref_param_type:`w` (e.g. :xref_param_type:`dict`). | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Axes | | - :xref_param_type:`Axes` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - BlockManager | | - :xref_param_type:`BlockManager` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - BlockManager for the new Series | | - :xref_param_type:`BlockManager` :xref_param_type:`for` :xref_param_type:`the` :xref_param_type:`new` :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Categorical | | - :xref_param_type:`Categorical` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Categorical or Index. | | - :xref_param_type:`Categorical` or Index. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Categorical or None | | - :xref_param_type:`Categorical` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Categorical or Series or array of integers if labels is False | | - :xref_param_type:`Categorical` or :xref_param_type:`Series ` or :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`integers ` :xref_param_type:`if` :xref_param_type:`labels` :xref_param_type:`is` :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Categorical with NA/NaN filled | | - :xref_param_type:`Categorical` :xref_param_type:`with` NA/NaN :xref_param_type:`filled` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Categorical with new categories added or None if inplace. | | - :xref_param_type:`Categorical` :xref_param_type:`with` :xref_param_type:`new` :xref_param_type:`categories` :xref_param_type:`added` or :xref_param_type:`None` :xref_param_type:`if` inplace. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Categorical with removed categories or None if inplace. | | - :xref_param_type:`Categorical` :xref_param_type:`with` :xref_param_type:`removed` :xref_param_type:`categories` or :xref_param_type:`None` :xref_param_type:`if` inplace. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Categorical with reordered categories or None if inplace. | | - :xref_param_type:`Categorical` :xref_param_type:`with` :xref_param_type:`reordered` :xref_param_type:`categories` or :xref_param_type:`None` :xref_param_type:`if` inplace. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Categorical with unused categories dropped or None if inplace. | | - :xref_param_type:`Categorical` :xref_param_type:`with` :xref_param_type:`unused` :xref_param_type:`categories` :xref_param_type:`dropped` or :xref_param_type:`None` :xref_param_type:`if` inplace. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - CategoricalDtype | | - :xref_param_type:`CategoricalDtype` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - CategoricalDtype or 'category' | | - :xref_param_type:`CategoricalDtype` or 'category' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - CategoricalDtype, defaults to existing | | - :xref_param_type:`CategoricalDtype`, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`existing` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - CategoricalIndex or Index | | - :xref_param_type:`CategoricalIndex` or :xref_param_type:`Index` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Column name for the x-axis values | | - :xref_param_type:`Column` :xref_param_type:`name` :xref_param_type:`for` :xref_param_type:`the` x-axis :xref_param_type:`values` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Column name for the y-axis values | | - :xref_param_type:`Column` :xref_param_type:`name` :xref_param_type:`for` :xref_param_type:`the` y-axis :xref_param_type:`values` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Columns were missing. Error message will list them. | | - :xref_param_type:`Columns` :xref_param_type:`were` missing. :xref_param_type:`Error` :xref_param_type:`message` :xref_param_type:`will` :xref_param_type:`list` them. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame | | - :xref_param_type:`DataFrame ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame (sorted) | | - :xref_param_type:`DataFrame ` (:xref_param_type:`sorted`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame of operation result | | - :xref_param_type:`DataFrame ` :xref_param_type:`of` :xref_param_type:`operation` :xref_param_type:`result` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame or Panel | | - :xref_param_type:`DataFrame ` or :xref_param_type:`Panel` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame or Series | | - :xref_param_type:`DataFrame ` or :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame or Series/dict-like object, or list of these | | - :xref_param_type:`DataFrame ` or Series/dict-like :xref_param_type:`object`, :xref_param_type:`or` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`these` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame or SparseDataFrame | | - :xref_param_type:`DataFrame ` or :xref_param_type:`SparseDataFrame` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame or Styler | | - :xref_param_type:`DataFrame ` or :xref_param_type:`Styler` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame with DatetimeIndex | | - :xref_param_type:`DataFrame ` :xref_param_type:`with` :xref_param_type:`DatetimeIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame, Series | | - :xref_param_type:`DataFrame `, :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame, Series with name field set, or list of DataFrame | | - :xref_param_type:`DataFrame `, :xref_param_type:`Series ` :xref_param_type:`with` :xref_param_type:`name` :xref_param_type:`field` :xref_param_type:`set`, :xref_param_type:`or` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`DataFrame ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame, or Series if drop == True | | - :xref_param_type:`DataFrame `, :xref_param_type:`or` :xref_param_type:`Series ` :xref_param_type:`if` :xref_param_type:`drop` == :xref_param_type:`True` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DataFrame, or object coercible into a DataFrame | | - :xref_param_type:`DataFrame `, :xref_param_type:`or` :xref_param_type:`object` :xref_param_type:`coercible` :xref_param_type:`into` :xref_param_type:`a` :xref_param_type:`DataFrame ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DateOffset | | - :xref_param_type:`DateOffset` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DateOffset object, or string | | - :xref_param_type:`DateOffset` :xref_param_type:`object`, :xref_param_type:`or` :xref_param_type:`string ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DateOffset or timedelta-like, optional | | - :xref_param_type:`DateOffset` or timedelta-like, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DateOffset, timedelta, or time rule string, default None | | - :xref_param_type:`DateOffset`, :xref_param_type:`timedelta`, :xref_param_type:`or` :xref_param_type:`time` :xref_param_type:`rule` :xref_param_type:`string `, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DateOffset, timedelta, or time rule string, optional | | - :xref_param_type:`DateOffset`, :xref_param_type:`timedelta`, :xref_param_type:`or` :xref_param_type:`time` :xref_param_type:`rule` :xref_param_type:`string `, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DatetimeIndex | | - :xref_param_type:`DatetimeIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DatetimeIndex / i8 ndarray | | - :xref_param_type:`DatetimeIndex` / :xref_param_type:`i8` :xref_param_type:`ndarray ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DatetimeIndex or TimedeltaIndex | | - :xref_param_type:`DatetimeIndex` or :xref_param_type:`TimedeltaIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DatetimeIndex or array-like | | - :xref_param_type:`DatetimeIndex` or :term:`array-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - DeepChainMap | | - :xref_param_type:`DeepChainMap` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Drop groups that do not pass the filter. True by default; | | - :xref_param_type:`Drop` :xref_param_type:`groups` :xref_param_type:`that` :xref_param_type:`do` :xref_param_type:`not` :xref_param_type:`pass` :xref_param_type:`the` filter. :xref_param_type:`True` :xref_param_type:`by` default; | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Either `left` or `right` is not an instance of `cls`. | | - :xref_param_type:`Either` `left` or `right` :xref_param_type:`is` :xref_param_type:`not` :xref_param_type:`an` :xref_param_type:`instance` :xref_param_type:`of` `cls`. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Exception | | - :xref_param_type:`Exception` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Exception or sub-class | | - :xref_param_type:`Exception` or sub-class | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - False (don't create an index), True (create all columns | | - :xref_param_type:`False` (don't :xref_param_type:`create` :xref_param_type:`an` :xref_param_type:`index`), :xref_param_type:`True` (:xref_param_type:`create` :xref_param_type:`all` :xref_param_type:`columns` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - False, int, default None | | - :xref_param_type:`False`, :xref_param_type:`int`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Grouped DataFrame | | - :xref_param_type:`Grouped` :xref_param_type:`DataFrame ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - How to join individual DataFrames | | - :xref_param_type:`How` :xref_param_type:`to` :xref_param_type:`join` :xref_param_type:`individual` :xref_param_type:`DataFrames` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - If key does not exist, or key is not unique and index is | | - :xref_param_type:`If` :xref_param_type:`key` :xref_param_type:`does` :xref_param_type:`not` :xref_param_type:`exist`, :xref_param_type:`or` :xref_param_type:`key` :xref_param_type:`is` :xref_param_type:`not` :xref_param_type:`unique` :xref_param_type:`and` :xref_param_type:`index` :xref_param_type:`is` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Index | | - :xref_param_type:`Index` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Index of maximum of values | | - :xref_param_type:`Index` :xref_param_type:`of` :xref_param_type:`maximum` :xref_param_type:`of` :xref_param_type:`values` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Index of minimum of values | | - :xref_param_type:`Index` :xref_param_type:`of` :xref_param_type:`minimum` :xref_param_type:`of` :xref_param_type:`values` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Index of the result | | - :xref_param_type:`Index` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`result` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Index or DatetimeIndex | | - :xref_param_type:`Index` or :xref_param_type:`DatetimeIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Index or MultiIndex | | - :xref_param_type:`Index` or :xref_param_type:`MultiIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Index or TimedeltaIndex | | - :xref_param_type:`Index` or :xref_param_type:`TimedeltaIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Index or array-like | | - :xref_param_type:`Index` or :term:`array-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Index or index-like, default None | | - :xref_param_type:`Index` or index-like, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Index or list/tuple of indices | | - :xref_param_type:`Index` or list/tuple :xref_param_type:`of` :xref_param_type:`indices` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Index, optional | | - :xref_param_type:`Index`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Index-like | | - Index-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Index-like (unique), optional | | - Index-like (:xref_param_type:`unique`), optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - IndexSlice | | - :xref_param_type:`IndexSlice` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Interval | | - :xref_param_type:`Interval` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - IntervalIndex | | - :xref_param_type:`IntervalIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Jinja2 Environment | | - :xref_param_type:`Jinja2` :xref_param_type:`Environment` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Jinja2 Loader | | - :xref_param_type:`Jinja2` :xref_param_type:`Loader` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Jinja2 Template | | - :xref_param_type:`Jinja2` :xref_param_type:`Template` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Matplotlib axis object | | - :xref_param_type:`Matplotlib` :xref_param_type:`axis` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Matplotlib axis object, default None | | - :xref_param_type:`Matplotlib` :xref_param_type:`axis` :xref_param_type:`object`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Matplotlib axis object, optional | | - :xref_param_type:`Matplotlib` :xref_param_type:`axis` :xref_param_type:`object`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MultiIndex | | - :xref_param_type:`MultiIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MultiIndex or array / Index of tuples | | - :xref_param_type:`MultiIndex` or :xref_param_type:`array ` / :xref_param_type:`Index` :xref_param_type:`of` :xref_param_type:`tuples ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - MultiIndex, list-of-tuples, or single tuple | | - :xref_param_type:`MultiIndex`, list-of-tuples, :xref_param_type:`or` :xref_param_type:`single` :xref_param_type:`tuple` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - NDFrame | | - :xref_param_type:`NDFrame` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - NDFrame, default None | | - :xref_param_type:`NDFrame`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - NaN or another value | | - :xref_param_type:`NaN` or :xref_param_type:`another` :xref_param_type:`value` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None | | - :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or int or array_like of ints. Default: None. | | - :xref_param_type:`None` or :xref_param_type:`int` or :term:`numpy:array_like` :xref_param_type:`of` ints. Default: None. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or str, optional | | - :xref_param_type:`None` or :xref_param_type:`str`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None or string-encoding | | - :xref_param_type:`None` or string-encoding | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None, integer or string axis name, optional | | - :xref_param_type:`None`, :xref_param_type:`integer ` or :xref_param_type:`string ` :xref_param_type:`axis` :xref_param_type:`name`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - None|'copy'|'same', default None | | - None|'copy'|'same', default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - NumPy array | | - :xref_param_type:`NumPy` :xref_param_type:`array ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - NumPy dtype (default: object) | | - :xref_param_type:`NumPy` :xref_param_type:`dtype ` (default: :xref_param_type:`object`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Object | | - :xref_param_type:`Object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Op | | - :xref_param_type:`Op` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Panel | | - :xref_param_type:`Panel` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Panel (or nd) | | - :xref_param_type:`Panel` (:xref_param_type:`or` :xref_param_type:`nd`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Panel or list of Panels | | - :xref_param_type:`Panel` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`Panels` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Panel, or object coercible to Panel | | - :xref_param_type:`Panel`, :xref_param_type:`or` :xref_param_type:`object` :xref_param_type:`coercible` :xref_param_type:`to` :xref_param_type:`Panel` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - PanelGroupBy | | - :xref_param_type:`PanelGroupBy` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Period frequency | | - :xref_param_type:`Period` :xref_param_type:`frequency` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Period or object | | - :xref_param_type:`Period` or :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - PeriodIndex | | - :xref_param_type:`PeriodIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - PeriodIndex with the new frequency | | - :xref_param_type:`PeriodIndex` :xref_param_type:`with` :xref_param_type:`the` :xref_param_type:`new` :xref_param_type:`frequency` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Python write mode, default 'w' | | - :xref_param_type:`Python` :xref_param_type:`write` :xref_param_type:`mode`, default 'w' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Resolution | | - :xref_param_type:`Resolution` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SQLAlchemy MetaData object, default None | | - :xref_param_type:`SQLAlchemy` :xref_param_type:`MetaData` :xref_param_type:`object`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SQLAlchemy connectable | | - :xref_param_type:`SQLAlchemy` :xref_param_type:`connectable` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SQLAlchemy connectable (engine/connection) or database string URI | | - :xref_param_type:`SQLAlchemy` :xref_param_type:`connectable` (engine/connection) :xref_param_type:`or` :xref_param_type:`database` :xref_param_type:`string ` :xref_param_type:`URI` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SQLAlchemy connectable (or database string URI) | | - :xref_param_type:`SQLAlchemy` :xref_param_type:`connectable` (:xref_param_type:`or` :xref_param_type:`database` :xref_param_type:`string ` :xref_param_type:`URI`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SQLAlchemy connectable(engine/connection) or database string URI | | - :xref_param_type:`SQLAlchemy` :xref_param_type:`connectable`\(engine/connection) :xref_param_type:`or` :xref_param_type:`database` :xref_param_type:`string ` :xref_param_type:`URI` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SQLAlchemy connectable(engine/connection) or sqlite3 connection | | - :xref_param_type:`SQLAlchemy` :xref_param_type:`connectable`\(engine/connection) :xref_param_type:`or` :xref_param_type:`sqlite3` :xref_param_type:`connection` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SQLAlchemy connectable(engine/connection), database string URI, | | - :xref_param_type:`SQLAlchemy` :xref_param_type:`connectable`\(engine/connection), :xref_param_type:`database` :xref_param_type:`string ` URI, | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SQLAlchemy engine or DBAPI2 connection (legacy mode) | | - :xref_param_type:`SQLAlchemy` :xref_param_type:`engine` or :xref_param_type:`DBAPI2` :xref_param_type:`connection` (:xref_param_type:`legacy` :xref_param_type:`mode`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Scope | | - :xref_param_type:`Scope` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Scope, optional, default None | | - :xref_param_type:`Scope`, optional, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series | | - :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series (bool dtype) | | - :xref_param_type:`Series ` (:xref_param_type:`bool` :xref_param_type:`dtype `) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series (new object) | | - :xref_param_type:`Series ` (:xref_param_type:`new` :xref_param_type:`object`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series (or DataFrame if level specified) | | - :xref_param_type:`Series ` (:xref_param_type:`or` :xref_param_type:`DataFrame ` :xref_param_type:`if` :xref_param_type:`level` :xref_param_type:`specified`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series or DataFrame | | - :xref_param_type:`Series ` or :xref_param_type:`DataFrame ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series or DataFrame if func returns a Series | | - :xref_param_type:`Series ` or :xref_param_type:`DataFrame ` :xref_param_type:`if` :xref_param_type:`func` :xref_param_type:`returns` :xref_param_type:`a` :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series or DataFrame, depending on the value of `typ`. | | - :xref_param_type:`Series ` or :xref_param_type:`DataFrame `, :xref_param_type:`depending` :xref_param_type:`on` :xref_param_type:`the` :xref_param_type:`value` :xref_param_type:`of` `typ`. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series or SparseDataFrame | | - :xref_param_type:`Series ` or :xref_param_type:`SparseDataFrame` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series or list/tuple of Series | | - :xref_param_type:`Series ` or list/tuple :xref_param_type:`of` :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series or scalar value | | - :xref_param_type:`Series ` or :xref_param_type:`scalar` :xref_param_type:`value` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series with DatetimeIndex | | - :xref_param_type:`Series ` :xref_param_type:`with` :xref_param_type:`DatetimeIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series with PeriodIndex | | - :xref_param_type:`Series ` :xref_param_type:`with` :xref_param_type:`PeriodIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series, DataFrame | | - :xref_param_type:`Series `, :xref_param_type:`DataFrame ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series, with -1 indicated where nan values are present | | - :xref_param_type:`Series `, :xref_param_type:`with` -1 :xref_param_type:`indicated` :xref_param_type:`where` :xref_param_type:`nan` :xref_param_type:`values` :xref_param_type:`are` :xref_param_type:`present` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series/Index of integer values | | - Series/Index :xref_param_type:`of` :xref_param_type:`integer ` :xref_param_type:`values` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series/Index of lists | | - Series/Index :xref_param_type:`of` :xref_param_type:`lists` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series/Index of objects | | - Series/Index :xref_param_type:`of` :xref_param_type:`objects` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series/Index of objects or str | | - Series/Index :xref_param_type:`of` :xref_param_type:`objects` or :xref_param_type:`str` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series/Index or DataFrame/MultiIndex of objects | | - Series/Index or DataFrame/MultiIndex :xref_param_type:`of` :xref_param_type:`objects` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Series/array of boolean values | | - Series/array :xref_param_type:`of` :xref_param_type:`boolean ` :xref_param_type:`values` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Setting this to True will show the grid | | - :xref_param_type:`Setting` :xref_param_type:`this` :xref_param_type:`to` :xref_param_type:`True` :xref_param_type:`will` :xref_param_type:`show` :xref_param_type:`the` :xref_param_type:`grid` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SparseArray | | - :xref_param_type:`SparseArray` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SparseDataFrame | | - :xref_param_type:`SparseDataFrame` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - SparseSeries | | - :xref_param_type:`SparseSeries` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - StataWriter instance | | - :xref_param_type:`StataWriter` :xref_param_type:`instance` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - String term expression, Expr, or list-like of Exprs. | | - :xref_param_type:`String` :xref_param_type:`term` :xref_param_type:`expression`, :xref_param_type:`Expr`, :xref_param_type:`or` list-like :xref_param_type:`of` Exprs. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - StringIO-like, optional | | - StringIO-like, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Styler | | - :xref_param_type:`Styler` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Term | | - :xref_param_type:`Term` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Term or Op | | - :xref_param_type:`Term` or :xref_param_type:`Op` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The class type to check against. | | - :xref_param_type:`The` :term:`python:class` :xref_param_type:`type` :xref_param_type:`to` :xref_param_type:`check` against. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The coerced dtype. | | - :xref_param_type:`The` :xref_param_type:`coerced` dtype. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The data to convert. | | - :xref_param_type:`The` :xref_param_type:`data` :xref_param_type:`to` convert. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The dtype could not be casted to a date-like dtype. | | - :xref_param_type:`The` :xref_param_type:`dtype ` :xref_param_type:`could` :xref_param_type:`not` :xref_param_type:`be` :xref_param_type:`casted` :xref_param_type:`to` :xref_param_type:`a` date-like dtype. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The dtype is an illegal date-like dtype (e.g. the | | - :xref_param_type:`The` :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`an` :xref_param_type:`illegal` date-like :xref_param_type:`dtype ` (e.g. :xref_param_type:`the` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The dtype that we want to coerce. | | - :xref_param_type:`The` :xref_param_type:`dtype ` :xref_param_type:`that` :xref_param_type:`we` :xref_param_type:`want` :xref_param_type:`to` coerce. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The error message provided does not match | | - :xref_param_type:`The` :xref_param_type:`error` :xref_param_type:`message` :xref_param_type:`provided` :xref_param_type:`does` :xref_param_type:`not` :xref_param_type:`match` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The error message to display. | | - :xref_param_type:`The` :xref_param_type:`error` :xref_param_type:`message` :xref_param_type:`to` display. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The extract dtype instance from the | | - :xref_param_type:`The` :xref_param_type:`extract` :xref_param_type:`dtype ` :xref_param_type:`instance` :xref_param_type:`from` :xref_param_type:`the` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The extract type instance from the | | - :xref_param_type:`The` :xref_param_type:`extract` :xref_param_type:`type` :xref_param_type:`instance` :xref_param_type:`from` :xref_param_type:`the` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The extracted numpy dtype.type-style object. | | - :xref_param_type:`The` :xref_param_type:`extracted` :xref_param_type:`numpy` dtype.type-style object. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The first dtype to compare | | - :xref_param_type:`The` :xref_param_type:`first` :xref_param_type:`dtype ` :xref_param_type:`to` :xref_param_type:`compare` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The first object being compared. | | - :xref_param_type:`The` :xref_param_type:`first` :xref_param_type:`object` :xref_param_type:`being` compared. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The month in which fiscal years end. {1, 2, ... 12} | | - :xref_param_type:`The` :xref_param_type:`month` :xref_param_type:`in` :xref_param_type:`which` :xref_param_type:`fiscal` :xref_param_type:`years` end. {1, 2, ... 12} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The name of the index returned. | | - :xref_param_type:`The` :xref_param_type:`name` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`index` returned. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The number of decimal places to use when encoding | | - :xref_param_type:`The` :xref_param_type:`number` :xref_param_type:`of` :xref_param_type:`decimal` :xref_param_type:`places` :xref_param_type:`to` :xref_param_type:`use` :xref_param_type:`when` :xref_param_type:`encoding` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The object to check. | | - :xref_param_type:`The` :xref_param_type:`object` :xref_param_type:`to` check. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The original array cast as a Categorical. If it already | | - :xref_param_type:`The` :xref_param_type:`original` :xref_param_type:`array ` :xref_param_type:`cast` :xref_param_type:`as` :xref_param_type:`a` Categorical. :xref_param_type:`If` :xref_param_type:`it` :xref_param_type:`already` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The original array cast to the float dtype if | | - :xref_param_type:`The` :xref_param_type:`original` :xref_param_type:`array ` :xref_param_type:`cast` :xref_param_type:`to` :xref_param_type:`the` :xref_param_type:`float` :xref_param_type:`dtype ` :xref_param_type:`if` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The original where clause if the check was successful. | | - :xref_param_type:`The` :xref_param_type:`original` :xref_param_type:`where` :xref_param_type:`clause` :xref_param_type:`if` :xref_param_type:`the` :xref_param_type:`check` :xref_param_type:`was` successful. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The passed in object is None. | | - :xref_param_type:`The` :xref_param_type:`passed` :xref_param_type:`in` :xref_param_type:`object` :xref_param_type:`is` None. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The quarter number that has the leap | | - :xref_param_type:`The` :xref_param_type:`quarter` :xref_param_type:`number` :xref_param_type:`that` :xref_param_type:`has` :xref_param_type:`the` :xref_param_type:`leap` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The row number of the line being parsed. | | - :xref_param_type:`The` :xref_param_type:`row` :xref_param_type:`number` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`line` :xref_param_type:`being` parsed. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The row number where the parsing error occurred. | | - :xref_param_type:`The` :xref_param_type:`row` :xref_param_type:`number` :xref_param_type:`where` :xref_param_type:`the` :xref_param_type:`parsing` :xref_param_type:`error` occurred. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The second dtype to compare | | - :xref_param_type:`The` :xref_param_type:`second` :xref_param_type:`dtype ` :xref_param_type:`to` :xref_param_type:`compare` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - The second object being compared. | | - :xref_param_type:`The` :xref_param_type:`second` :xref_param_type:`object` :xref_param_type:`being` compared. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - TimeSeries | | - :xref_param_type:`TimeSeries` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - TimeSeries with PeriodIndex | | - :xref_param_type:`TimeSeries` :xref_param_type:`with` :xref_param_type:`PeriodIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Timedelta | | - :xref_param_type:`Timedelta` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - TimedeltaIndex | | - :xref_param_type:`TimedeltaIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - TimedeltaIndex or array-like | | - :xref_param_type:`TimedeltaIndex` or :term:`array-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Timestamp giving most recent fiscal year end | | - :xref_param_type:`Timestamp` :xref_param_type:`giving` :xref_param_type:`most` :xref_param_type:`recent` :xref_param_type:`fiscal` :xref_param_type:`year` :xref_param_type:`end` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Union[Index, MultiIndex], inferred | | - :xref_param_type:`Union`\[:xref_param_type:`Index`, :xref_param_type:`MultiIndex`], :xref_param_type:`inferred` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Warning, default FutureWarning | | - :xref_param_type:`Warning`, default :xref_param_type:`FutureWarning` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not columns could become a MultiIndex | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`columns` :xref_param_type:`could` :xref_param_type:`become` :xref_param_type:`a` :xref_param_type:`MultiIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype is of a | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`a` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype is of a boolean dtype. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`a` :xref_param_type:`boolean ` dtype. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype is of a compex dtype. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`a` :xref_param_type:`compex` dtype. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype is of a float dtype. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`a` :xref_param_type:`float` dtype. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype is of a numeric dtype. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`a` :xref_param_type:`numeric` dtype. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype is of a signed integer dtype | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`a` :xref_param_type:`signed` :xref_param_type:`integer ` :xref_param_type:`dtype ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype is of an | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`an` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype is of an integer dtype | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`an` :xref_param_type:`integer ` :xref_param_type:`dtype ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype is of an integer dtype. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`an` :xref_param_type:`integer ` dtype. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype is of the | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`the` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype is of the datetime64 dtype. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`datetime64` dtype. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype is of the datetime64[ns] dtype. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`datetime64`\[:xref_param_type:`ns`] dtype. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype is of the int64 dtype. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`int64` dtype. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype is of the string dtype. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`string ` dtype. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array or dtype should be converted to int64. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`array ` or :xref_param_type:`dtype ` :xref_param_type:`should` :xref_param_type:`be` :xref_param_type:`converted` :xref_param_type:`to` int64. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array-like is a | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :term:`array-like` :xref_param_type:`is` :xref_param_type:`a` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array-like is a datetime | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :term:`array-like` :xref_param_type:`is` :xref_param_type:`a` :xref_param_type:`datetime` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array-like is a datetime array-like with | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :term:`array-like` :xref_param_type:`is` :xref_param_type:`a` :xref_param_type:`datetime` :term:`array-like` :xref_param_type:`with` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array-like is a datetime-like array-like. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :term:`array-like` :xref_param_type:`is` :xref_param_type:`a` datetime-like array-like. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array-like is a pandas sparse array. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :term:`array-like` :xref_param_type:`is` :xref_param_type:`a` :xref_param_type:`pandas` :xref_param_type:`sparse ` array. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array-like is a periodical | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :term:`array-like` :xref_param_type:`is` :xref_param_type:`a` :xref_param_type:`periodical` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array-like is a periodical index. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :term:`array-like` :xref_param_type:`is` :xref_param_type:`a` :xref_param_type:`periodical` index. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array-like is of a Categorical instance. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :term:`array-like` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`a` :xref_param_type:`Categorical` instance. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array-like is of a pandas | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :term:`array-like` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`a` :xref_param_type:`pandas` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array-like or dtype is | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :term:`array-like` or :xref_param_type:`dtype ` :xref_param_type:`is` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array-like or dtype is of | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :term:`array-like` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array-like or dtype is of the Period dtype. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :term:`array-like` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`Period` dtype. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the array-like or dtype is of the object dtype. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :term:`array-like` or :xref_param_type:`dtype ` :xref_param_type:`is` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`object` dtype. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the exception raised is an unorderable exception. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`exception` :xref_param_type:`raised` :xref_param_type:`is` :xref_param_type:`an` :xref_param_type:`unorderable` exception. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the line is empty. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`line` :xref_param_type:`is` empty. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether or not the two dtypes are equal. | | - :xref_param_type:`Whether` or :xref_param_type:`not` :xref_param_type:`the` :xref_param_type:`two` :xref_param_type:`dtypes` :xref_param_type:`are` equal. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether the object is a DateOffset or listlike of DatetOffsets | | - :xref_param_type:`Whether` :xref_param_type:`the` :xref_param_type:`object` :xref_param_type:`is` :xref_param_type:`a` :xref_param_type:`DateOffset` or :xref_param_type:`listlike` :xref_param_type:`of` :xref_param_type:`DatetOffsets` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether to copy the data or not. | | - :xref_param_type:`Whether` :xref_param_type:`to` :xref_param_type:`copy` :xref_param_type:`the` :xref_param_type:`data` or not. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether we return a comparing a datetime-like | | - :xref_param_type:`Whether` :xref_param_type:`we` :xref_param_type:`return` :xref_param_type:`a` :xref_param_type:`comparing` :xref_param_type:`a` datetime-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - Whether we return a comparing a string-like | | - :xref_param_type:`Whether` :xref_param_type:`we` :xref_param_type:`return` :xref_param_type:`a` :xref_param_type:`comparing` :xref_param_type:`a` string-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - _HtmlFrameParser subclass | | - :xref_param_type:`_HtmlFrameParser` :xref_param_type:`subclass` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `Categorical` | | - `Categorical` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `DataFrameFormatter` | | - `DataFrameFormatter` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `mask`, applies to both sides (array like) | | - `mask`, :xref_param_type:`applies` :xref_param_type:`to` :xref_param_type:`both` :xref_param_type:`sides` (:xref_param_type:`array ` :xref_param_type:`like`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `new values` either scalar or an array like aligned with `values` | | - `new values` :xref_param_type:`either` :xref_param_type:`scalar` or :xref_param_type:`an` :xref_param_type:`array ` :xref_param_type:`like` :xref_param_type:`aligned` :xref_param_type:`with` `values` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - `values`, updated in-place (array like) | | - `values`, :xref_param_type:`updated` in-place (:xref_param_type:`array ` :xref_param_type:`like`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a "kinds" map (dict of column name -> kind), or None if column | | - :xref_param_type:`a` "kinds" :xref_param_type:`map` (:xref_param_type:`dict` :xref_param_type:`of` :xref_param_type:`column` :xref_param_type:`name` -> :xref_param_type:`kind`), :xref_param_type:`or` :xref_param_type:`None` :xref_param_type:`if` :xref_param_type:`column` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a DataFrame containing the original Index data. | | - :xref_param_type:`a` :xref_param_type:`DataFrame ` :xref_param_type:`containing` :xref_param_type:`the` :xref_param_type:`original` :xref_param_type:`Index` data. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a DataFrame containing the original MultiIndex data. | | - :xref_param_type:`a` :xref_param_type:`DataFrame ` :xref_param_type:`containing` :xref_param_type:`the` :xref_param_type:`original` :xref_param_type:`MultiIndex` data. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a Table object | | - :xref_param_type:`a` :xref_param_type:`Table` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a TimeGrouper object | | - :xref_param_type:`a` :xref_param_type:`TimeGrouper` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a boolean array | | - :xref_param_type:`a` :xref_param_type:`boolean ` :xref_param_type:`array ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a collections.Mapping subclass or other constructor | | - :xref_param_type:`a` :xref_param_type:`collections.Mapping` :xref_param_type:`subclass` or :xref_param_type:`other` :xref_param_type:`constructor` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a comparable array of values representing bins into which to bin | | - :xref_param_type:`a` :xref_param_type:`comparable` :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`values` :xref_param_type:`representing` :xref_param_type:`bins` :xref_param_type:`into` :xref_param_type:`which` :xref_param_type:`to` :xref_param_type:`bin` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a dict of dtype -> BlockManager | | - :xref_param_type:`a` :xref_param_type:`dict` :xref_param_type:`of` :xref_param_type:`dtype ` -> :xref_param_type:`BlockManager` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a dict of dtype -> Constructor Types | | - :xref_param_type:`a` :xref_param_type:`dict` :xref_param_type:`of` :xref_param_type:`dtype ` -> :xref_param_type:`Constructor` :xref_param_type:`Types` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a dict of table_name to table_columns, None is acceptable as the | | - :xref_param_type:`a` :xref_param_type:`dict` :xref_param_type:`of` :xref_param_type:`table_name` :xref_param_type:`to` :xref_param_type:`table_columns`, :xref_param_type:`None` :xref_param_type:`is` :xref_param_type:`acceptable` :xref_param_type:`as` :xref_param_type:`the` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a intp array | | - :xref_param_type:`a` :xref_param_type:`intp` :xref_param_type:`array ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a list of columns that if not None, will limit the return | | - :xref_param_type:`a` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`columns` :xref_param_type:`that` :xref_param_type:`if` :xref_param_type:`not` :xref_param_type:`None`, :xref_param_type:`will` :xref_param_type:`limit` :xref_param_type:`the` :xref_param_type:`return` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a list of the tables | | - :xref_param_type:`a` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`tables` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a ndarray | | - :xref_param_type:`a` :xref_param_type:`ndarray ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a ndarray/object | | - :xref_param_type:`a` ndarray/object | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a numpy array of object dtype | | - :xref_param_type:`a` :xref_param_type:`numpy` :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`object` :xref_param_type:`dtype ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a pandas object | | - :xref_param_type:`a` :xref_param_type:`pandas` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a path in native format | | - :xref_param_type:`a` :xref_param_type:`path` :xref_param_type:`in` :xref_param_type:`native` :xref_param_type:`format` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a sequence or mapping of Series, DataFrame, or Panel objects | | - :xref_param_type:`a` :term:`python:sequence` or :xref_param_type:`mapping` :xref_param_type:`of` :xref_param_type:`Series `, :xref_param_type:`DataFrame `, :xref_param_type:`or` :xref_param_type:`Panel` :xref_param_type:`objects` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a string that designates the indexable table; all of its | | - :xref_param_type:`a` :xref_param_type:`string ` :xref_param_type:`that` :xref_param_type:`designates` :xref_param_type:`the` :xref_param_type:`indexable` table; :xref_param_type:`all` :xref_param_type:`of` :xref_param_type:`its` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a url, filepath (str, py.path.local or pathlib.Path), | | - :xref_param_type:`a` :xref_param_type:`url`, :xref_param_type:`filepath` (:xref_param_type:`str`, :xref_param_type:`py.path.local` or :xref_param_type:`pathlib.Path`), | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - a valid JSON string or file-like, default: None | | - :xref_param_type:`a` :xref_param_type:`valid` :xref_param_type:`JSON` :xref_param_type:`string ` or :term:`file-like`, default: :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - an array of the indexes | | - :xref_param_type:`an` :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`indexes` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - an array of the masks | | - :xref_param_type:`an` :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`masks` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - an array of the values | | - :xref_param_type:`an` :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`values` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - an empty memory space where we are putting the chunk | | - :xref_param_type:`an` :xref_param_type:`empty` :xref_param_type:`memory` :xref_param_type:`space` :xref_param_type:`where` :xref_param_type:`we` :xref_param_type:`are` :xref_param_type:`putting` :xref_param_type:`the` :xref_param_type:`chunk` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - an encoding that will encode the query terms | | - :xref_param_type:`an` :xref_param_type:`encoding` :xref_param_type:`that` :xref_param_type:`will` :xref_param_type:`encode` :xref_param_type:`the` :xref_param_type:`query` :xref_param_type:`terms` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - an expanded filepath or the | | - :xref_param_type:`an` :xref_param_type:`expanded` :xref_param_type:`filepath` or :xref_param_type:`the` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - an integer indexer | | - :xref_param_type:`an` :xref_param_type:`integer ` :xref_param_type:`indexer` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - an iterable | | - :xref_param_type:`an` :term:`python:iterable` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - an object or objects to serialize | | - :xref_param_type:`an` :xref_param_type:`object` or :xref_param_type:`objects` :xref_param_type:`to` :xref_param_type:`serialize` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - any | | - :xref_param_type:`any` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - any iterable which has a len() | | - :xref_param_type:`any` :term:`python:iterable` :xref_param_type:`which` :xref_param_type:`has` :xref_param_type:`a` :xref_param_type:`len`\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - any object | | - :xref_param_type:`any` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - any, default np.nan | | - :xref_param_type:`any`, default :xref_param_type:`np.nan` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - anything to be formatted | | - :xref_param_type:`anything` :xref_param_type:`to` :xref_param_type:`be` :xref_param_type:`formatted` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array | | - :xref_param_type:`array ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array addend. | | - :xref_param_type:`array ` addend. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of Holiday objects | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`Holiday` :xref_param_type:`objects` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of arrays | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`arrays` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of grouping | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`grouping` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of int64 | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`int64` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of integers suitable for passing to iloc | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`integers ` :xref_param_type:`suitable` :xref_param_type:`for` :xref_param_type:`passing` :xref_param_type:`to` :xref_param_type:`iloc` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of offsets (into 'values' argument) of bins. | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`offsets` (:xref_param_type:`into` 'values' :xref_param_type:`argument`) :xref_param_type:`of` bins. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of pandas.tseries.offsets or | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`pandas.tseries.offsets` :xref_param_type:`or` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array of values | | - :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`values` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or boolean, default None | | - :xref_param_type:`array ` or :xref_param_type:`boolean `, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or dtype | | - :xref_param_type:`array ` or :xref_param_type:`dtype ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array or scalar addend. | | - :xref_param_type:`array ` or :xref_param_type:`scalar` addend. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like | | - :term:`array-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like (1-dimensional) | | - :term:`array-like` (1-dimensional) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like (1-dimensional), optional | | - :term:`array-like` (1-dimensional), optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like of bool or bool | | - :term:`array-like` :xref_param_type:`of` :xref_param_type:`bool` or :xref_param_type:`bool` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like or Categorical, (1-dimensional) | | - :term:`array-like` or :xref_param_type:`Categorical`, (1-dimensional) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like or Index (1d) | | - :term:`array-like` or :xref_param_type:`Index` (1d) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like or None | | - :term:`array-like` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, Series, or DataFrame | | - :term:`array-like`, :xref_param_type:`Series `, :xref_param_type:`or` :xref_param_type:`DataFrame ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, Series, or list of arrays/Series | | - :term:`array-like`, :xref_param_type:`Series `, :xref_param_type:`or` :xref_param_type:`list` :xref_param_type:`of` arrays/Series | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, callable, or None | | - :term:`array-like`, :xref_param_type:`callable`, :xref_param_type:`or` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, dict, or scalar value | | - :term:`array-like`, :xref_param_type:`dict`, :xref_param_type:`or` :xref_param_type:`scalar` :xref_param_type:`value` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, integers | | - :term:`array-like`, :xref_param_type:`integers ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, object to be reshaped | | - :term:`array-like`, :xref_param_type:`object` :xref_param_type:`to` :xref_param_type:`be` :xref_param_type:`reshaped` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, optional | | - :term:`array-like`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array-like, scalar | | - :term:`array-like`, :xref_param_type:`scalar` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like | | - :term:`numpy:array_like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like of bool | | - :term:`numpy:array_like` :xref_param_type:`of` :xref_param_type:`bool` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - array_like or list of array-likes | | - :term:`numpy:array_like` or :xref_param_type:`list` :xref_param_type:`of` array-likes | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - arraylike | | - :xref_param_type:`arraylike` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - axis to provide concatenation | | - :xref_param_type:`axis` :xref_param_type:`to` :xref_param_type:`provide` :xref_param_type:`concatenation` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - axis to shift, default 0 | | - :xref_param_type:`axis` :xref_param_type:`to` :xref_param_type:`shift`, default 0 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - basestring | | - :xref_param_type:`basestring` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - binary operator | | - :xref_param_type:`binary` :xref_param_type:`operator` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool | | - :xref_param_type:`bool` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool (default False) | | - :xref_param_type:`bool` (default :xref_param_type:`False`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool (default True) | | - :xref_param_type:`bool` (default :xref_param_type:`True`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool (default: True) | | - :xref_param_type:`bool` (default: :xref_param_type:`True`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool (default=False) | | - :xref_param_type:`bool` (default=False) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool / string {'equiv'}, default 'equiv' | | - :xref_param_type:`bool` / :xref_param_type:`string ` {'equiv'}, default 'equiv' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool / string {'equiv'}, default False | | - :xref_param_type:`bool` / :xref_param_type:`string ` {'equiv'}, default :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or None, default True | | - :xref_param_type:`bool` or :xref_param_type:`None`, default :xref_param_type:`True` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or int, default False | | - :xref_param_type:`bool` or :xref_param_type:`int`, default :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool or same types as `to_replace`, default False | | - :xref_param_type:`bool` or :xref_param_type:`same` :xref_param_type:`types` :xref_param_type:`as` `to_replace`, default :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, (optional) | | - :xref_param_type:`bool`, (optional) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default False | | - :xref_param_type:`bool`, default :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default NaN | | - :xref_param_type:`bool`, default :xref_param_type:`NaN` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default True | | - :xref_param_type:`bool`, default :xref_param_type:`True` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default True. | | - :xref_param_type:`bool`, default True. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, default try | | - :xref_param_type:`bool`, default :xref_param_type:`try` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, defaults to False | | - :xref_param_type:`bool`, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, defaults to True | | - :xref_param_type:`bool`, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`True` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, optional | | - :xref_param_type:`bool`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, optional, default True | | - :xref_param_type:`bool`, optional, default :xref_param_type:`True` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bool, optional, default=False | | - :xref_param_type:`bool`, optional, default=False | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean | | - :xref_param_type:`boolean ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean (default False) | | - :xref_param_type:`boolean ` (default :xref_param_type:`False`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean (default True) | | - :xref_param_type:`boolean ` (default :xref_param_type:`True`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean (default: False) | | - :xref_param_type:`boolean ` (default: :xref_param_type:`False`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean array or None | | - :xref_param_type:`boolean ` :xref_param_type:`array ` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean array or boolean or None | | - :xref_param_type:`boolean ` :xref_param_type:`array ` or :xref_param_type:`boolean ` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean ndarray | | - :xref_param_type:`boolean ` :xref_param_type:`ndarray ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean o rstring, default True | | - :xref_param_type:`boolean ` :xref_param_type:`o` :xref_param_type:`rstring`, default :xref_param_type:`True` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean or None, default None | | - :xref_param_type:`boolean ` or :xref_param_type:`None`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean or dict, default True | | - :xref_param_type:`boolean ` or :xref_param_type:`dict`, default :xref_param_type:`True` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean or list of string, default True | | - :xref_param_type:`boolean ` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`string `, default :xref_param_type:`True` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean or string, default True | | - :xref_param_type:`boolean ` or :xref_param_type:`string `, default :xref_param_type:`True` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean to set whether this categorical is ordered (True) or | | - :xref_param_type:`boolean ` :xref_param_type:`to` :xref_param_type:`set` :xref_param_type:`whether` :xref_param_type:`this` :xref_param_type:`categorical` :xref_param_type:`is` :xref_param_type:`ordered` (:xref_param_type:`True`) :xref_param_type:`or` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean whether to append to an existing msgpack | | - :xref_param_type:`boolean ` :xref_param_type:`whether` :xref_param_type:`to` :xref_param_type:`append` :xref_param_type:`to` :xref_param_type:`an` :xref_param_type:`existing` :xref_param_type:`msgpack` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean whether to treat passed axes as | | - :xref_param_type:`boolean ` :xref_param_type:`whether` :xref_param_type:`to` :xref_param_type:`treat` :xref_param_type:`passed` :xref_param_type:`axes` :xref_param_type:`as` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, | | - boolean, | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, (default False) | | - :xref_param_type:`boolean `, (default :xref_param_type:`False`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, (default: False) | | - :xref_param_type:`boolean `, (default: :xref_param_type:`False`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, True by default | | - :xref_param_type:`boolean `, :xref_param_type:`True` :xref_param_type:`by` default | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, automatically close the store at the end of | | - :xref_param_type:`boolean `, :xref_param_type:`automatically` :xref_param_type:`close` :xref_param_type:`the` :xref_param_type:`store` :xref_param_type:`at` :xref_param_type:`the` :xref_param_type:`end` :xref_param_type:`of` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, default False | | - :xref_param_type:`boolean `, default :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, default False. | | - :xref_param_type:`boolean `, default False. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, default False. Do the block manager | | - :xref_param_type:`boolean `, default False. :xref_param_type:`Do` :xref_param_type:`the` :xref_param_type:`block` :xref_param_type:`manager` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, default None | | - :xref_param_type:`boolean `, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, default True | | - :xref_param_type:`boolean `, default :xref_param_type:`True` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, default True if ax is None else False | | - :xref_param_type:`boolean `, default :xref_param_type:`True` :xref_param_type:`if` :xref_param_type:`ax` :xref_param_type:`is` :xref_param_type:`None` :xref_param_type:`else` :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, default is True, | | - :xref_param_type:`boolean `, default :xref_param_type:`is` True, | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, default to False | | - :xref_param_type:`boolean `, default :xref_param_type:`to` :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, default to self.center | | - :xref_param_type:`boolean `, default :xref_param_type:`to` :xref_param_type:`self.center` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, defaults to True | | - :xref_param_type:`boolean `, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`True` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, if True, return an iterator to the unpacker | | - :xref_param_type:`boolean `, :xref_param_type:`if` :xref_param_type:`True`, :xref_param_type:`return` :xref_param_type:`an` :xref_param_type:`iterator` :xref_param_type:`to` :xref_param_type:`the` :xref_param_type:`unpacker` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, optional | | - :xref_param_type:`boolean `, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, perform alignment on other/cond | | - :xref_param_type:`boolean `, :xref_param_type:`perform` :xref_param_type:`alignment` :xref_param_type:`on` other/cond | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, perform alignment on other/cond, default is True | | - :xref_param_type:`boolean `, :xref_param_type:`perform` :xref_param_type:`alignment` :xref_param_type:`on` other/cond, default :xref_param_type:`is` :xref_param_type:`True` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, return an iterator, default False | | - :xref_param_type:`boolean `, :xref_param_type:`return` :xref_param_type:`an` :xref_param_type:`iterator`, default :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, should automatically close the store when | | - :xref_param_type:`boolean `, :xref_param_type:`should` :xref_param_type:`automatically` :xref_param_type:`close` :xref_param_type:`the` :xref_param_type:`store` :xref_param_type:`when` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, whether to use the default iterator | | - :xref_param_type:`boolean `, :xref_param_type:`whether` :xref_param_type:`to` :xref_param_type:`use` :xref_param_type:`the` default :xref_param_type:`iterator` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean, {'all', 'index', 'columns'}, or {0,1}, default False | | - :xref_param_type:`boolean `, {'all', 'index', 'columns'}, :xref_param_type:`or` {0,1}, default :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - boolean/string, default None | | - boolean/string, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - bytes | | - :xref_param_type:`bytes` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable | | - :xref_param_type:`callable` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable accepting (1d-mask, 1d values, indexer) | | - :xref_param_type:`callable` :xref_param_type:`accepting` (1d-mask, 1d :xref_param_type:`values`, :xref_param_type:`indexer`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable bound to pandas object | | - :xref_param_type:`callable` :xref_param_type:`bound` :xref_param_type:`to` :xref_param_type:`pandas` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable or tuple of (callable, string) | | - :xref_param_type:`callable` or :xref_param_type:`tuple` :xref_param_type:`of` (:xref_param_type:`callable`, :xref_param_type:`string `) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable(1d-array) -> 1d-array, default None | | - :xref_param_type:`callable`\(1d-array) -> 1d-array, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable, default None | | - :xref_param_type:`callable`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - callable, optional | | - :xref_param_type:`callable`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - category or list of categories | | - :xref_param_type:`category` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`categories` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - category or list-like of category | | - :xref_param_type:`category` or list-like :xref_param_type:`of` :xref_param_type:`category` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - character, default "," | | - :xref_param_type:`character`, default "," | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - character, default ',' | | - :xref_param_type:`character`, default ',' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - class | | - :term:`python:class` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - class, default dict | | - :term:`python:class`, default :xref_param_type:`dict` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - closed end of interval; 'left' or 'right' | | - :xref_param_type:`closed` :xref_param_type:`end` :xref_param_type:`of` interval; 'left' or 'right' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - collections.Mapping | | - :xref_param_type:`collections.Mapping` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - collections.Mapping like {column -> {index -> value}} | | - :xref_param_type:`collections.Mapping` :xref_param_type:`like` {:xref_param_type:`column` -> {:xref_param_type:`index` -> :xref_param_type:`value`}} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - column identifier, defaults to None | | - :xref_param_type:`column` :xref_param_type:`identifier`, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - column label | | - :xref_param_type:`column` :xref_param_type:`label` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - column label or list of column labels / arrays | | - :xref_param_type:`column` :xref_param_type:`label` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`column` :xref_param_type:`labels` / :xref_param_type:`arrays` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - column label or sequence of labels, optional | | - :xref_param_type:`column` :xref_param_type:`label` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`labels`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - column name | | - :xref_param_type:`column` :xref_param_type:`name` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - column name or list of column names | | - :xref_param_type:`column` :xref_param_type:`name` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`column` :xref_param_type:`names` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - column name or list of names, or vector | | - :xref_param_type:`column` :xref_param_type:`name` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`names`, :xref_param_type:`or` :xref_param_type:`vector` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - conformed data (may be resampled) | | - :xref_param_type:`conformed` :xref_param_type:`data` (:xref_param_type:`may` :xref_param_type:`be` :xref_param_type:`resampled`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - converted object | | - :xref_param_type:`converted` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - data converted to either an Int64Index or a | | - :xref_param_type:`data` :xref_param_type:`converted` :xref_param_type:`to` :xref_param_type:`either` :xref_param_type:`an` :xref_param_type:`Int64Index` or :xref_param_type:`a` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - data for new Categorical | | - :xref_param_type:`data` :xref_param_type:`for` :xref_param_type:`new` :xref_param_type:`Categorical` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - data type, or dict of column name -> data type | | - :xref_param_type:`data` :xref_param_type:`type`, :xref_param_type:`or` :xref_param_type:`dict` :xref_param_type:`of` :xref_param_type:`column` :xref_param_type:`name` -> :xref_param_type:`data` :xref_param_type:`type` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - date or array of dates | | - :xref_param_type:`date` or :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`dates` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - date, string, int | | - :xref_param_type:`date`, :xref_param_type:`string `, :xref_param_type:`int` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - datetime | | - :xref_param_type:`datetime` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - datetime (default None) | | - :xref_param_type:`datetime` (default :xref_param_type:`None`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - datetime if parsing succeeded. | | - :xref_param_type:`datetime` :xref_param_type:`if` :xref_param_type:`parsing` succeeded. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - datetime of converted dates | | - :xref_param_type:`datetime` :xref_param_type:`of` :xref_param_type:`converted` :xref_param_type:`dates` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - datetime or Timestamp | | - :xref_param_type:`datetime` or :xref_param_type:`Timestamp` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - datetime.time or string | | - :xref_param_type:`datetime.time` or :xref_param_type:`string ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - default NaN, fill value for missing values. | | - default :xref_param_type:`NaN`, :xref_param_type:`fill` :xref_param_type:`value` :xref_param_type:`for` :xref_param_type:`missing` values. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - default None, provide an encoding for strings | | - default :xref_param_type:`None`, :xref_param_type:`provide` :xref_param_type:`an` :xref_param_type:`encoding` :xref_param_type:`for` :xref_param_type:`strings ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - deprecated, cursor is obtained from connection, default: None | | - :xref_param_type:`deprecated`, :xref_param_type:`cursor` :xref_param_type:`is` :xref_param_type:`obtained` :xref_param_type:`from` :xref_param_type:`connection`, default: :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - deprecated, use `expand` | | - :xref_param_type:`deprecated`, :xref_param_type:`use` `expand` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict | | - :xref_param_type:`dict` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict (python 3), str or None (python 2) | | - :xref_param_type:`dict` (:xref_param_type:`python` 3), :xref_param_type:`str` or :xref_param_type:`None` (:xref_param_type:`python` 2) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict of column name to SQL type, default None | | - :xref_param_type:`dict` :xref_param_type:`of` :xref_param_type:`column` :xref_param_type:`name` :xref_param_type:`to` :xref_param_type:`SQL` :xref_param_type:`type`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict of columns that specify minimum string sizes | | - :xref_param_type:`dict` :xref_param_type:`of` :xref_param_type:`columns` :xref_param_type:`that` :xref_param_type:`specify` :xref_param_type:`minimum` :xref_param_type:`string ` :xref_param_type:`sizes` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict of {axis: indexer} | | - :xref_param_type:`dict` :xref_param_type:`of` {axis: :xref_param_type:`indexer`} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict or DataFrame | | - :xref_param_type:`dict` or :xref_param_type:`DataFrame ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict or None, optional | | - :xref_param_type:`dict` or :xref_param_type:`None`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict or None, optional, default None | | - :xref_param_type:`dict` or :xref_param_type:`None`, optional, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict or Scope or None, optional, default None | | - :xref_param_type:`dict` or :xref_param_type:`Scope` or :xref_param_type:`None`, optional, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict or callable | | - :xref_param_type:`dict` or :xref_param_type:`callable` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict or dict-like | | - :xref_param_type:`dict` or dict-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict or list of dicts | | - :xref_param_type:`dict` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`dicts` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict, default None | | - :xref_param_type:`dict`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict, optional | | - :xref_param_type:`dict`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dict-like | | - dict-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dtype | | - :xref_param_type:`dtype ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dtype of data | | - :xref_param_type:`dtype ` :xref_param_type:`of` :xref_param_type:`data` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dtype will be based on the type of the Index values. | | - :xref_param_type:`dtype ` :xref_param_type:`will` :xref_param_type:`be` :xref_param_type:`based` :xref_param_type:`on` :xref_param_type:`the` :xref_param_type:`type` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`Index` values. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dtype, default None | | - :xref_param_type:`dtype `, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dtype, default np.uint8 | | - :xref_param_type:`dtype `, default :xref_param_type:`np.uint8` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - dtype, type | | - :xref_param_type:`dtype `, :xref_param_type:`type` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - end value, period-like, optional | | - :xref_param_type:`end` :xref_param_type:`value`, period-like, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ending date, datetime-like, optional | | - :xref_param_type:`ending` :xref_param_type:`date`, datetime-like, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - expected TOTAL row size of this table | | - :xref_param_type:`expected` :xref_param_type:`TOTAL` :xref_param_type:`row` :xref_param_type:`size` :xref_param_type:`of` :xref_param_type:`this` :xref_param_type:`table` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file object | | - :xref_param_type:`file` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file-like | | - :term:`file-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - file-like object or list | | - :term:`file-like` :xref_param_type:`object` or :xref_param_type:`list` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - fixed length string dtyped array | | - :xref_param_type:`fixed` :xref_param_type:`length` :xref_param_type:`string ` :xref_param_type:`dtyped` :xref_param_type:`array ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float | | - :xref_param_type:`float` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or Series | | - :xref_param_type:`float` or :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or array-like, default 0.5 (50% quantile) | | - :xref_param_type:`float` or :term:`array-like`, default 0.5 (50% :xref_param_type:`quantile`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or array_like | | - :xref_param_type:`float` or :term:`numpy:array_like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or array_like, default None | | - :xref_param_type:`float` or :term:`numpy:array_like`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float or object | | - :xref_param_type:`float` or :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, default NaN | | - :xref_param_type:`float`, default :xref_param_type:`NaN` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, default None | | - :xref_param_type:`float`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, defaults to NaN (missing) | | - :xref_param_type:`float`, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`NaN` (:xref_param_type:`missing`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - float, optional | | - :xref_param_type:`float`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - force encoded string to be ASCII, default True. | | - :xref_param_type:`force` :xref_param_type:`encoded` :xref_param_type:`string ` :xref_param_type:`to` :xref_param_type:`be` :xref_param_type:`ASCII`, default True. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - frequency | | - :xref_param_type:`frequency` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - frequency string | | - :xref_param_type:`frequency` :xref_param_type:`string ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function | | - :xref_param_type:`function` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function (optional) | | - :xref_param_type:`function` (optional) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function or dict | | - :xref_param_type:`function` or :xref_param_type:`dict` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function, default None | | - :xref_param_type:`function`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function, default to _use_window | | - :xref_param_type:`function`, default :xref_param_type:`to` :xref_param_type:`_use_window` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function, dict, or Series | | - :xref_param_type:`function`, :xref_param_type:`dict`, :xref_param_type:`or` :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function, optional | | - :xref_param_type:`function`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - function, optional, | | - :xref_param_type:`function`, optional, | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - generator | | - :xref_param_type:`generator` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - group identifier in the store. Can be omitted if the HDF file | | - :xref_param_type:`group` :xref_param_type:`identifier` :xref_param_type:`in` :xref_param_type:`the` store. :xref_param_type:`Can` :xref_param_type:`be` :xref_param_type:`omitted` :xref_param_type:`if` :xref_param_type:`the` :xref_param_type:`HDF` :xref_param_type:`file` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - hashable | | - :xref_param_type:`hashable` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - hint to the hashtable sizer | | - :xref_param_type:`hint` :xref_param_type:`to` :xref_param_type:`the` :xref_param_type:`hashtable` :xref_param_type:`sizer` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - holiday calendar | | - :xref_param_type:`holiday` :xref_param_type:`calendar` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - how axes slice to others (dict) | | - :xref_param_type:`how` :xref_param_type:`axes` :xref_param_type:`slice` :xref_param_type:`to` :xref_param_type:`others` (:xref_param_type:`dict`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - identifier of index column, defaults to None | | - :xref_param_type:`identifier` :xref_param_type:`of` :xref_param_type:`index` :xref_param_type:`column`, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - if None, then use the dtype of the values, else coerce to this type | | - :xref_param_type:`if` :xref_param_type:`None`, :xref_param_type:`then` :xref_param_type:`use` :xref_param_type:`the` :xref_param_type:`dtype ` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`values`, :xref_param_type:`else` :xref_param_type:`coerce` :xref_param_type:`to` :xref_param_type:`this` :xref_param_type:`type` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - if True always make a copy even if no upcast is required | | - :xref_param_type:`if` :xref_param_type:`True` :xref_param_type:`always` :xref_param_type:`make` :xref_param_type:`a` :xref_param_type:`copy` :xref_param_type:`even` :xref_param_type:`if` :xref_param_type:`no` :xref_param_type:`upcast` :xref_param_type:`is` :xref_param_type:`required` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - if evaluates to True, drop rows from all tables if any single | | - :xref_param_type:`if` :xref_param_type:`evaluates` :xref_param_type:`to` :xref_param_type:`True`, :xref_param_type:`drop` :xref_param_type:`rows` :xref_param_type:`from` :xref_param_type:`all` :xref_param_type:`tables` :xref_param_type:`if` :xref_param_type:`any` :xref_param_type:`single` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - if the Grouping is a column in self.obj and hence among | | - :xref_param_type:`if` :xref_param_type:`the` :xref_param_type:`Grouping` :xref_param_type:`is` :xref_param_type:`a` :xref_param_type:`column` :xref_param_type:`in` :xref_param_type:`self.obj` :xref_param_type:`and` :xref_param_type:`hence` :xref_param_type:`among` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - if we do not have a passed timezone, coerce to M8[ns] ndarray | | - :xref_param_type:`if` :xref_param_type:`we` :xref_param_type:`do` :xref_param_type:`not` :xref_param_type:`have` :xref_param_type:`a` :xref_param_type:`passed` :xref_param_type:`timezone`, :xref_param_type:`coerce` :xref_param_type:`to` :xref_param_type:`M8`\[:xref_param_type:`ns`] :xref_param_type:`ndarray ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ignored | | - :xref_param_type:`ignored` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - index | | - :xref_param_type:`index` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - index for the new Series | | - :xref_param_type:`index` :xref_param_type:`for` :xref_param_type:`the` :xref_param_type:`new` :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - index-like | | - index-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - input object | | - :xref_param_type:`input` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - instance or subclass of collections.Mapping | | - :xref_param_type:`instance` or :xref_param_type:`subclass` :xref_param_type:`of` :xref_param_type:`collections.Mapping` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int | | - :xref_param_type:`int` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int (can only be zero) | | - :xref_param_type:`int` (:xref_param_type:`can` :xref_param_type:`only` :xref_param_type:`be` :xref_param_type:`zero`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int (default 10000) | | - :xref_param_type:`int` (default 10000) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int (default: 0) | | - :xref_param_type:`int` (default: 0) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int (default: 0), or other RangeIndex instance. | | - :xref_param_type:`int` (default: 0), :xref_param_type:`or` :xref_param_type:`other` :xref_param_type:`RangeIndex` instance. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int (default: 1) | | - :xref_param_type:`int` (default: 1) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int if unique index, slice if monotonic index, else mask | | - :xref_param_type:`int` :xref_param_type:`if` :xref_param_type:`unique` :xref_param_type:`index`, :xref_param_type:`slice` :xref_param_type:`if` :xref_param_type:`monotonic` :xref_param_type:`index`, :xref_param_type:`else` :xref_param_type:`mask` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int level | | - :xref_param_type:`int` :xref_param_type:`level` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or None | | - :xref_param_type:`int` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or None, optional, default None | | - :xref_param_type:`int` or :xref_param_type:`None`, optional, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or Series (if level specified) | | - :xref_param_type:`int` or :xref_param_type:`Series ` (:xref_param_type:`if` :xref_param_type:`level` :xref_param_type:`specified`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or array | | - :xref_param_type:`int` or :xref_param_type:`array ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or axis name | | - :xref_param_type:`int` or :xref_param_type:`axis` :xref_param_type:`name` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or basestring | | - :xref_param_type:`int` or :xref_param_type:`basestring` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or float | | - :xref_param_type:`int` or :xref_param_type:`float` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or level name, default None | | - :xref_param_type:`int` or :xref_param_type:`level` :xref_param_type:`name`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or list | | - :xref_param_type:`int` or :xref_param_type:`list` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or list of ints | | - :xref_param_type:`int` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`ints ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or list, default None | | - :xref_param_type:`int` or :xref_param_type:`list`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or list, optional | | - :xref_param_type:`int` or :xref_param_type:`list`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or list-like or None, optional | | - :xref_param_type:`int` or list-like or :xref_param_type:`None`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or list-like or slice or None, optional | | - :xref_param_type:`int` or list-like or :xref_param_type:`slice` or :xref_param_type:`None`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or ndarray | | - :xref_param_type:`int` or :xref_param_type:`ndarray ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or numpy.random.RandomState, optional | | - :xref_param_type:`int` or :xref_param_type:`numpy.random.RandomState`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or sequence, default 0 | | - :xref_param_type:`int` or :term:`python:sequence`, default 0 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or str | | - :xref_param_type:`int` or :xref_param_type:`str` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or str, default 0 | | - :xref_param_type:`int` or :xref_param_type:`str`, default 0 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or str, default last level | | - :xref_param_type:`int` or :xref_param_type:`str`, default :xref_param_type:`last` :xref_param_type:`level` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or str, optional | | - :xref_param_type:`int` or :xref_param_type:`str`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or string | | - :xref_param_type:`int` or :xref_param_type:`string ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or string axis name | | - :xref_param_type:`int` or :xref_param_type:`string ` :xref_param_type:`axis` :xref_param_type:`name` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or string axis name, optional | | - :xref_param_type:`int` or :xref_param_type:`string ` :xref_param_type:`axis` :xref_param_type:`name`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or string, default 0 | | - :xref_param_type:`int` or :xref_param_type:`string `, default 0 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or string, optional | | - :xref_param_type:`int` or :xref_param_type:`string `, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int or tuple of ints, the new shape | | - :xref_param_type:`int` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`ints `, :xref_param_type:`the` :xref_param_type:`new` :xref_param_type:`shape` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, 0-9, default None | | - :xref_param_type:`int`, 0-9, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, Series, or array-like | | - :xref_param_type:`int`, :xref_param_type:`Series `, :xref_param_type:`or` :term:`array-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, array, or Series, default None | | - :xref_param_type:`int`, :xref_param_type:`array `, :xref_param_type:`or` :xref_param_type:`Series `, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, array-like | | - :xref_param_type:`int`, :term:`array-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, default -1 | | - :xref_param_type:`int`, default -1 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, default -1 (all) | | - :xref_param_type:`int`, default -1 (:xref_param_type:`all`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, default 0 | | - :xref_param_type:`int`, default 0 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, default 0 (no flags) | | - :xref_param_type:`int`, default 0 (:xref_param_type:`no` :xref_param_type:`flags`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, default 1 | | - :xref_param_type:`int`, default 1 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, default 2 | | - :xref_param_type:`int`, default 2 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, default 5 | | - :xref_param_type:`int`, default 5 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, default None | | - :xref_param_type:`int`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, defaults None | | - :xref_param_type:`int`, :xref_param_type:`defaults` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, defaults to None | | - :xref_param_type:`int`, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, dict, Series | | - :xref_param_type:`int`, :xref_param_type:`dict`, :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, float, Interval | | - :xref_param_type:`int`, :xref_param_type:`float`, :xref_param_type:`Interval` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, level name, or sequence of int/level names (default None) | | - :xref_param_type:`int`, :xref_param_type:`level` :xref_param_type:`name`, :xref_param_type:`or` :term:`python:sequence` :xref_param_type:`of` int/level :xref_param_type:`names` (default :xref_param_type:`None`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, level name, or sequence of such, default None | | - :xref_param_type:`int`, :xref_param_type:`level` :xref_param_type:`name`, :xref_param_type:`or` :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`such`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, np.random.RandomState, None. | | - :xref_param_type:`int`, :xref_param_type:`np.random.RandomState`, None. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, optional | | - :xref_param_type:`int`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, optional, > 0 | | - :xref_param_type:`int`, optional, > 0 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, optional, default 0 | | - :xref_param_type:`int`, optional, default 0 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, optional, default 2 | | - :xref_param_type:`int`, optional, default 2 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, or offset | | - :xref_param_type:`int`, :xref_param_type:`or` :xref_param_type:`offset` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, sequence of scalars, or IntervalIndex | | - :xref_param_type:`int`, :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`scalars`, :xref_param_type:`or` :xref_param_type:`IntervalIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, slice object or boolean mask | | - :xref_param_type:`int`, :xref_param_type:`slice` :xref_param_type:`object` or :xref_param_type:`boolean ` :xref_param_type:`mask` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, slice, container | | - :xref_param_type:`int`, :xref_param_type:`slice`, :xref_param_type:`container` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, slice, or sequence of integers | | - :xref_param_type:`int`, :xref_param_type:`slice`, :xref_param_type:`or` :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`integers ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, str or None | | - :xref_param_type:`int`, :xref_param_type:`str` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, str, default None | | - :xref_param_type:`int`, :xref_param_type:`str`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, str, tuple, or list, default None | | - :xref_param_type:`int`, :xref_param_type:`str`, :xref_param_type:`tuple`, :xref_param_type:`or` :xref_param_type:`list`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, string, or list of these, default -1 (last level) | | - :xref_param_type:`int`, :xref_param_type:`string `, :xref_param_type:`or` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`these`, default -1 (:xref_param_type:`last` :xref_param_type:`level`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int, string, or list of these, default last level | | - :xref_param_type:`int`, :xref_param_type:`string `, :xref_param_type:`or` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`these`, default :xref_param_type:`last` :xref_param_type:`level` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int/array, default to _get_window() | | - int/array, default :xref_param_type:`to` :xref_param_type:`_get_window`\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int/level name or list thereof | | - int/level :xref_param_type:`name` or :xref_param_type:`list` :xref_param_type:`thereof` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - int/level name or list thereof, optional | | - int/level :xref_param_type:`name` or :xref_param_type:`list` :xref_param_type:`thereof`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer (defaults to None), row number to start selection | | - :xref_param_type:`integer ` (:xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`None`), :xref_param_type:`row` :xref_param_type:`number` :xref_param_type:`to` :xref_param_type:`start` :xref_param_type:`selection` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer or Timedelta, optional, default None | | - :xref_param_type:`integer ` or :xref_param_type:`Timedelta`, optional, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer or array of quantiles | | - :xref_param_type:`integer ` or :xref_param_type:`array ` :xref_param_type:`of` :xref_param_type:`quantiles` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer, default 1 | | - :xref_param_type:`integer `, default 1 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer, default 10 | | - :xref_param_type:`integer `, default 10 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer, default 4 | | - :xref_param_type:`integer `, default 4 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer, default None | | - :xref_param_type:`integer `, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer, float, string, datetime, list, tuple, 1-d array, Series | | - :xref_param_type:`integer `, :xref_param_type:`float`, :xref_param_type:`string `, :xref_param_type:`datetime`, :xref_param_type:`list`, :xref_param_type:`tuple`, 1-d :xref_param_type:`array `, :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer, optional | | - :xref_param_type:`integer `, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - integer, optional, defaults to the max length of the strings | | - :xref_param_type:`integer `, optional, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`the` :xref_param_type:`max` :xref_param_type:`length` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`strings ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - internal use only. pprint_thing() is mutually-recursive | | - :xref_param_type:`internal` :xref_param_type:`use` only. :xref_param_type:`pprint_thing`\() :xref_param_type:`is` mutually-recursive | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - interpret the index as indexers, default False | | - :xref_param_type:`interpret` :xref_param_type:`the` :xref_param_type:`index` :xref_param_type:`as` :xref_param_type:`indexers`, default :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - interpret the index/col as indexers, default False | | - :xref_param_type:`interpret` :xref_param_type:`the` index/col :xref_param_type:`as` :xref_param_type:`indexers`, default :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - interpret the passed labels as indexers, default False | | - :xref_param_type:`interpret` :xref_param_type:`the` :xref_param_type:`passed` :xref_param_type:`labels` :xref_param_type:`as` :xref_param_type:`indexers`, default :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - interval boundary to use for labeling; 'left' or 'right' | | - :xref_param_type:`interval` :xref_param_type:`boundary` :xref_param_type:`to` :xref_param_type:`use` :xref_param_type:`for` labeling; 'left' or 'right' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - intp array, optional | | - :xref_param_type:`intp` :xref_param_type:`array `, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - io.excel.ExcelFile | | - :xref_param_type:`io.excel.ExcelFile` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - item label (panel item) | | - :xref_param_type:`item` :xref_param_type:`label` (:xref_param_type:`panel` :xref_param_type:`item`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable | | - :term:`python:iterable` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable of int | | - :term:`python:iterable` :xref_param_type:`of` :xref_param_type:`int` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable of names | | - :term:`python:iterable` :xref_param_type:`of` :xref_param_type:`names` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable of node-like | | - :term:`python:iterable` :xref_param_type:`of` node-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable of strings (optional) | | - :term:`python:iterable` :xref_param_type:`of` :xref_param_type:`strings ` (optional) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable of usecols | | - :term:`python:iterable` :xref_param_type:`of` :xref_param_type:`usecols` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable, Series, DataFrame or dictionary | | - :term:`python:iterable`, :xref_param_type:`Series `, :xref_param_type:`DataFrame ` or :xref_param_type:`dictionary ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable, default None | | - :term:`python:iterable`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - iterable, optional | | - :term:`python:iterable`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - keyword arguments to pass on to the constructor | | - :xref_param_type:`keyword` :xref_param_type:`arguments` :xref_param_type:`to` :xref_param_type:`pass` :xref_param_type:`on` :xref_param_type:`to` :xref_param_type:`the` :xref_param_type:`constructor` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - keyword, value pairs | | - :xref_param_type:`keyword`, :xref_param_type:`value` :xref_param_type:`pairs` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - label | | - :xref_param_type:`label` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - label of the slice bound | | - :xref_param_type:`label` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`slice` :xref_param_type:`bound` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - label or list | | - :xref_param_type:`label` or :xref_param_type:`list` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - label or list, or array-like | | - :xref_param_type:`label` or :xref_param_type:`list`, :xref_param_type:`or` :term:`array-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - label or position, optional | | - :xref_param_type:`label` or :xref_param_type:`position`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - label or sequence of labels | | - :xref_param_type:`label` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`labels` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - label or tuple | | - :xref_param_type:`label` or :xref_param_type:`tuple` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - label or tuple of labels (one for each level) | | - :xref_param_type:`label` or :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`labels` (:xref_param_type:`one` :xref_param_type:`for` :xref_param_type:`each` :xref_param_type:`level`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - label or tuple, can be partial. Default None | | - :xref_param_type:`label` or :xref_param_type:`tuple`, :xref_param_type:`can` :xref_param_type:`be` partial. :xref_param_type:`Default` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - label or tuple, default None | | - :xref_param_type:`label` or :xref_param_type:`tuple`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - label rotation angle | | - :xref_param_type:`label` :xref_param_type:`rotation` :xref_param_type:`angle` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - label, default None | | - :xref_param_type:`label`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - label/slice/list/mask or a sequence of such | | - label/slice/list/mask or :xref_param_type:`a` :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`such` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list | | - :xref_param_type:`list` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list (column labels) | | - :xref_param_type:`list` (:xref_param_type:`column` :xref_param_type:`labels`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list (row labels) | | - :xref_param_type:`list` (:xref_param_type:`row` :xref_param_type:`labels`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list / sequence of array-likes | | - :xref_param_type:`list` / :term:`python:sequence` :xref_param_type:`of` array-likes | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list / sequence of iterables | | - :xref_param_type:`list` / :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`iterables` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list / sequence of strings or None | | - :xref_param_type:`list` / :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`strings ` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list / sequence of tuple-likes | | - :xref_param_type:`list` / :term:`python:sequence` :xref_param_type:`of` tuple-likes | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of (BlockManager, {axis: indexer,...}) tuples | | - :xref_param_type:`list` :xref_param_type:`of` (:xref_param_type:`BlockManager`, {axis: indexer,...}) :xref_param_type:`tuples ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of (BlockPlacement, JoinUnit) tuples | | - :xref_param_type:`list` :xref_param_type:`of` (:xref_param_type:`BlockPlacement`, :xref_param_type:`JoinUnit`) :xref_param_type:`tuples ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of Block | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`Block` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of DataFrames | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`DataFrames` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of DataFrames before operation is applied | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`DataFrames` :xref_param_type:`before` :xref_param_type:`operation` :xref_param_type:`is` :xref_param_type:`applied` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of Grouping objects | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`Grouping` :xref_param_type:`objects` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of Index | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`Index` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of Index objects | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`Index` :xref_param_type:`objects` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of Indexes | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`Indexes` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of SingleBlockManagers | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`SingleBlockManagers` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of Term (or convertible) objects, optional | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`Term` (:xref_param_type:`or` :xref_param_type:`convertible`) :xref_param_type:`objects`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of Terms (or convertible to) | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`Terms` (:xref_param_type:`or` :xref_param_type:`convertible` :xref_param_type:`to`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of acceptable numpy.dtype | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`acceptable` :xref_param_type:`numpy.dtype` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of arrays | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`arrays` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of blocks | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`blocks` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of boolean | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`boolean ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of columns to create as data columns, or True to | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`columns` :xref_param_type:`to` :xref_param_type:`create` :xref_param_type:`as` :xref_param_type:`data` :xref_param_type:`columns`, :xref_param_type:`or` :xref_param_type:`True` :xref_param_type:`to` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of dict-like or None, optional | | - :xref_param_type:`list` :xref_param_type:`of` dict-like or :xref_param_type:`None`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of dicts, optional | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`dicts`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of dtypes | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`dtypes` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of file-like objects | | - :xref_param_type:`list` :xref_param_type:`of` :term:`file-like` :xref_param_type:`objects` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of int or list of str | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`int` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`str` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of int representing new level order. | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`int` :xref_param_type:`representing` :xref_param_type:`new` :xref_param_type:`level` order. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of integers | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`integers ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of label arrays | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`label` :xref_param_type:`arrays` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of list of strings | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of lists | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`lists` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of ndarrays | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`ndarrays` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of new axis labels | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`new` :xref_param_type:`axis` :xref_param_type:`labels` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of node-like | | - :xref_param_type:`list` :xref_param_type:`of` node-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of openpyxl.styles.Color | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`openpyxl.styles.Color` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of paths (string or list of strings), default None | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`paths` (:xref_param_type:`string ` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings `), default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of sequences, default None | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`sequences`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of size of the levels | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`size` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`levels` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of str | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`str` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of str to be drawn as titles of left DataFrames | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`str` :xref_param_type:`to` :xref_param_type:`be` :xref_param_type:`drawn` :xref_param_type:`as` :xref_param_type:`titles` :xref_param_type:`of` :xref_param_type:`left` :xref_param_type:`DataFrames` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of strings | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list of strings or None | | - :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings ` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list or dict, default: None | | - :xref_param_type:`list` or :xref_param_type:`dict`, default: :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list or dict, optional | | - :xref_param_type:`list` or :xref_param_type:`dict`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list or str | | - :xref_param_type:`list` or :xref_param_type:`str` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list or tuple, optional, default: None | | - :xref_param_type:`list` or :xref_param_type:`tuple`, optional, default: :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list(str) (optional) | | - :xref_param_type:`list`\(:xref_param_type:`str`) (optional) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list, default None | | - :xref_param_type:`list`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list, default: None | | - :xref_param_type:`list`, default: :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list, if supplied, only call the block if the filter is in | | - :xref_param_type:`list`, :xref_param_type:`if` :xref_param_type:`supplied`, :xref_param_type:`only` :xref_param_type:`call` :xref_param_type:`the` :xref_param_type:`block` :xref_param_type:`if` :xref_param_type:`the` :xref_param_type:`filter` :xref_param_type:`is` :xref_param_type:`in` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list, optional | | - :xref_param_type:`list`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list, tuple or dict, optional, default: None | | - :xref_param_type:`list`, :xref_param_type:`tuple` or :xref_param_type:`dict`, optional, default: :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list, tuple, 1-d array, or Series | | - :xref_param_type:`list`, :xref_param_type:`tuple`, 1-d :xref_param_type:`array `, :xref_param_type:`or` :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-liek of bins | | - list-liek :xref_param_type:`of` :xref_param_type:`bins` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like | | - list-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like of Categorical, CategoricalIndex, | | - list-like :xref_param_type:`of` :xref_param_type:`Categorical`, CategoricalIndex, | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like of dtypes or None (default), optional, | | - list-like :xref_param_type:`of` :xref_param_type:`dtypes` or :xref_param_type:`None` (default), optional, | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like of list-likes | | - list-like :xref_param_type:`of` list-likes | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like of numbers, optional | | - list-like :xref_param_type:`of` :xref_param_type:`numbers`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like or None, default None | | - list-like or :xref_param_type:`None`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like or None, optional, default None | | - list-like or :xref_param_type:`None`, optional, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like positional indexer | | - list-like :xref_param_type:`positional` :xref_param_type:`indexer` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like which has the same length as collections | | - list-like :xref_param_type:`which` :xref_param_type:`has` :xref_param_type:`the` :xref_param_type:`same` :xref_param_type:`length` :xref_param_type:`as` :xref_param_type:`collections` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like, containing floats from interval [0,1] | | - list-like, :xref_param_type:`containing` :xref_param_type:`floats ` :xref_param_type:`from` :xref_param_type:`interval` [0,1] | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like, default None | | - list-like, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like, dict-like or callable | | - list-like, dict-like or :xref_param_type:`callable` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like, int or str, default 0 | | - list-like, :xref_param_type:`int` or :xref_param_type:`str`, default 0 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like, optional | | - list-like, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list-like, or list of list-likes | | - list-like, :xref_param_type:`or` :xref_param_type:`list` :xref_param_type:`of` list-likes | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - list_like | | - :xref_param_type:`list_like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - major axis label (panel item row) | | - :xref_param_type:`major` :xref_param_type:`axis` :xref_param_type:`label` (:xref_param_type:`panel` :xref_param_type:`item` :xref_param_type:`row`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - mapping, function, label, or list of labels | | - :xref_param_type:`mapping`, :xref_param_type:`function`, :xref_param_type:`label`, :xref_param_type:`or` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`labels` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib Artist or its list-like | | - :xref_param_type:`matplotlib` :xref_param_type:`Artist` or :xref_param_type:`its` list-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib Axes object | | - :xref_param_type:`matplotlib` :xref_param_type:`Axes` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib Axes object, or its list-like | | - :xref_param_type:`matplotlib` :xref_param_type:`Axes` :xref_param_type:`object`, :xref_param_type:`or` :xref_param_type:`its` list-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib Text object, or its list-like | | - :xref_param_type:`matplotlib` :xref_param_type:`Text` :xref_param_type:`object`, :xref_param_type:`or` :xref_param_type:`its` list-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib axes object, default None | | - :xref_param_type:`matplotlib` :xref_param_type:`axes` :xref_param_type:`object`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib axis object | | - :xref_param_type:`matplotlib` :xref_param_type:`axis` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib.AxesSubplot or np.array of them | | - :xref_param_type:`matplotlib.AxesSubplot` or :xref_param_type:`np.array` :xref_param_type:`of` :xref_param_type:`them` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - matplotlib.Figure | | - :xref_param_type:`matplotlib.Figure` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - maybe a string version of the object | | - :xref_param_type:`maybe` :xref_param_type:`a` :xref_param_type:`string ` :xref_param_type:`version` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - minor axis label (panel item column) | | - :xref_param_type:`minor` :xref_param_type:`axis` :xref_param_type:`label` (:xref_param_type:`panel` :xref_param_type:`item` :xref_param_type:`column`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - my parent HDFStore | | - :xref_param_type:`my` :xref_param_type:`parent` :xref_param_type:`HDFStore` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - name of module as a replacement, optional. | | - :xref_param_type:`name` :xref_param_type:`of` :xref_param_type:`module` :xref_param_type:`as` :xref_param_type:`a` :xref_param_type:`replacement`, optional. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - name of module to be deprecated. | | - :xref_param_type:`name` :xref_param_type:`of` :xref_param_type:`module` :xref_param_type:`to` :xref_param_type:`be` deprecated. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - name, tuple/list of names, or array-like | | - :xref_param_type:`name`, tuple/list :xref_param_type:`of` :xref_param_type:`names`, :xref_param_type:`or` :term:`array-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - name/number, defaults to None | | - name/number, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray | | - :xref_param_type:`ndarray ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (1-d) | | - :xref_param_type:`ndarray ` (1-d) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (1-d) or Index | | - :xref_param_type:`ndarray ` (1-d) :xref_param_type:`or` :xref_param_type:`Index` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (boolean dtype) | | - :xref_param_type:`ndarray ` (:xref_param_type:`boolean ` :xref_param_type:`dtype `) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray (structured dtype), list of tuples, dict, or DataFrame | | - :xref_param_type:`ndarray ` (:xref_param_type:`structured` :xref_param_type:`dtype `), :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`tuples `, :xref_param_type:`dict`, :xref_param_type:`or` :xref_param_type:`DataFrame ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray of floats | | - :xref_param_type:`ndarray ` :xref_param_type:`of` :xref_param_type:`floats ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray of int64 or None | | - :xref_param_type:`ndarray ` :xref_param_type:`of` :xref_param_type:`int64` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or None, default None | | - :xref_param_type:`ndarray ` or :xref_param_type:`None`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or object value | | - :xref_param_type:`ndarray ` or :xref_param_type:`object` :xref_param_type:`value` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray or scalar | | - :xref_param_type:`ndarray ` or :xref_param_type:`scalar` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray with updated values | | - :xref_param_type:`ndarray ` :xref_param_type:`with` :xref_param_type:`updated` :xref_param_type:`values` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray with values replace by the fill_value | | - :xref_param_type:`ndarray ` :xref_param_type:`with` :xref_param_type:`values` :xref_param_type:`replace` :xref_param_type:`by` :xref_param_type:`the` :xref_param_type:`fill_value` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, Categorical | | - :xref_param_type:`ndarray `, :xref_param_type:`Categorical` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray, scalar, or pandas object | | - :xref_param_type:`ndarray `, :xref_param_type:`scalar`, :xref_param_type:`or` :xref_param_type:`pandas` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray-like | | - ndarray-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndarray-like or scalar | | - ndarray-like or :xref_param_type:`scalar` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - ndim(self)-1 | | - :xref_param_type:`ndim`\(:xref_param_type:`self`)-1 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - new codes | | - :xref_param_type:`new` :xref_param_type:`codes` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - new ref_items | | - :xref_param_type:`new` :xref_param_type:`ref_items` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - new shape | | - :xref_param_type:`new` :xref_param_type:`shape` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - node-like | | - node-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - non-negative integer | | - non-negative :xref_param_type:`integer ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - np.array / Series / Index / list-like | | - :xref_param_type:`np.array` / :xref_param_type:`Series ` / :xref_param_type:`Index` / list-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - np.dtype, optional | | - :xref_param_type:`np.dtype`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - np.ndarray | | - :xref_param_type:`np.ndarray` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - np.ndarray or None | | - :xref_param_type:`np.ndarray` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - np.ndarray or iterable | | - :xref_param_type:`np.ndarray` or :term:`python:iterable` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - nrows to include in iteration, return an iterator | | - :xref_param_type:`nrows` :xref_param_type:`to` :xref_param_type:`include` :xref_param_type:`in` :xref_param_type:`iteration`, :xref_param_type:`return` :xref_param_type:`an` :xref_param_type:`iterator` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - number | | - :xref_param_type:`number` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - number/name of the axis, defaults to 0 | | - number/name :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`axis`, :xref_param_type:`defaults` :xref_param_type:`to` 0 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numeric if parsing succeeded. | | - :xref_param_type:`numeric` :xref_param_type:`if` :xref_param_type:`parsing` succeeded. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numeric or datetime-like, default None | | - :xref_param_type:`numeric` or datetime-like, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numeric, string, or DateOffset, default None | | - :xref_param_type:`numeric`, :xref_param_type:`string `, :xref_param_type:`or` :xref_param_type:`DateOffset`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy dtype or pandas type | | - :xref_param_type:`numpy` :xref_param_type:`dtype ` or :xref_param_type:`pandas` :xref_param_type:`type` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy dtype or pandas type, optional | | - :xref_param_type:`numpy` :xref_param_type:`dtype ` or :xref_param_type:`pandas` :xref_param_type:`type`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy ndarray (structured or homogeneous), dict, or DataFrame | | - :xref_param_type:`numpy` :xref_param_type:`ndarray ` (:xref_param_type:`structured` or :xref_param_type:`homogeneous`), :xref_param_type:`dict`, :xref_param_type:`or` :xref_param_type:`DataFrame ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy-array | | - numpy-array | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - numpy.dtype or None | | - :xref_param_type:`numpy.dtype` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object | | - :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object (the node to index) | | - :xref_param_type:`object` (:xref_param_type:`the` :xref_param_type:`node` :xref_param_type:`to` :xref_param_type:`index`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object to be converted | | - :xref_param_type:`object` :xref_param_type:`to` :xref_param_type:`be` :xref_param_type:`converted` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object to be converted if possible | | - :xref_param_type:`object` :xref_param_type:`to` :xref_param_type:`be` :xref_param_type:`converted` :xref_param_type:`if` :xref_param_type:`possible` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object to be tested, returned from boxplot | | - :xref_param_type:`object` :xref_param_type:`to` :xref_param_type:`be` :xref_param_type:`tested`, :xref_param_type:`returned` :xref_param_type:`from` :xref_param_type:`boxplot` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object, default '' | | - :xref_param_type:`object`, default '' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object, default None | | - :xref_param_type:`object`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object, defaults to first n levels (n=1 or len(key)) | | - :xref_param_type:`object`, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`first` :xref_param_type:`n` :xref_param_type:`levels` (n=1 or :xref_param_type:`len`\(:xref_param_type:`key`)) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object, optional | | - :xref_param_type:`object`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object, optional, default None | | - :xref_param_type:`object`, optional, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - object, type of objs | | - :xref_param_type:`object`, :xref_param_type:`type` :xref_param_type:`of` :xref_param_type:`objs` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - objects or methods in module that will no longer be | | - :xref_param_type:`objects` or :xref_param_type:`methods` :xref_param_type:`in` :xref_param_type:`module` :xref_param_type:`that` :xref_param_type:`will` :xref_param_type:`no` :xref_param_type:`longer` :xref_param_type:`be` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - one of the converted indices either exceeded the number | | - :xref_param_type:`one` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`converted` :xref_param_type:`indices` :xref_param_type:`either` :xref_param_type:`exceeded` :xref_param_type:`the` :xref_param_type:`number` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - one-parameter function, optional | | - one-parameter :xref_param_type:`function`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - openpyxl.styles.Alignment | | - :xref_param_type:`openpyxl.styles.Alignment` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - openpyxl.styles.Border | | - :xref_param_type:`openpyxl.styles.Border` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - openpyxl.styles.Color | | - :xref_param_type:`openpyxl.styles.Color` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - openpyxl.styles.Fill | | - :xref_param_type:`openpyxl.styles.Fill` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - openpyxl.styles.Font | | - :xref_param_type:`openpyxl.styles.Font` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - openpyxl.styles.Side | | - :xref_param_type:`openpyxl.styles.Side` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional | | - optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional (if not supplied, use self.axes) | | - optional (:xref_param_type:`if` :xref_param_type:`not` :xref_param_type:`supplied`, :xref_param_type:`use` :xref_param_type:`self.axes`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional categories, defaults to existing | | - optional :xref_param_type:`categories`, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`existing` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional constant from csv module | | - optional :xref_param_type:`constant` :xref_param_type:`from` :xref_param_type:`csv` :xref_param_type:`module` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional int | | - optional :xref_param_type:`int` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional list | | - optional :xref_param_type:`list` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional name attribute, defaults to existing | | - optional :xref_param_type:`name` :xref_param_type:`attribute`, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`existing` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional ordered attribute, defaults to existing | | - optional :xref_param_type:`ordered` :xref_param_type:`attribute`, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`existing` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional sequence of objects | | - optional :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`objects` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional, a list of columns that if not None, will limit the | | - optional, :xref_param_type:`a` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`columns` :xref_param_type:`that` :xref_param_type:`if` :xref_param_type:`not` :xref_param_type:`None`, :xref_param_type:`will` :xref_param_type:`limit` :xref_param_type:`the` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional, a passed method name ; possibly to take different | | - optional, :xref_param_type:`a` :xref_param_type:`passed` :xref_param_type:`method` :xref_param_type:`name` ; :xref_param_type:`possibly` :xref_param_type:`to` :xref_param_type:`take` :xref_param_type:`different` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional, array-like | | - optional, :term:`array-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional, boolean, return an iterator, default False | | - optional, :xref_param_type:`boolean `, :xref_param_type:`return` :xref_param_type:`an` :xref_param_type:`iterator`, default :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional, defaults False. | | - optional, :xref_param_type:`defaults` False. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional, defaults to tab | | - optional, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`tab` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional, integer (defaults to None), row number to start | | - optional, :xref_param_type:`integer ` (:xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`None`), :xref_param_type:`row` :xref_param_type:`number` :xref_param_type:`to` :xref_param_type:`start` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional, nrows to include in iteration, return an iterator | | - optional, :xref_param_type:`nrows` :xref_param_type:`to` :xref_param_type:`include` :xref_param_type:`in` :xref_param_type:`iteration`, :xref_param_type:`return` :xref_param_type:`an` :xref_param_type:`iterator` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - optional, {'a', 'w', 'r+'}, default 'a' | | - optional, {'a', 'w', 'r+'}, default 'a' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - other names for a single axis (dict) | | - :xref_param_type:`other` :xref_param_type:`names` :xref_param_type:`for` :xref_param_type:`a` :xref_param_type:`single` :xref_param_type:`axis` (:xref_param_type:`dict`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - other plotting keyword arguments | | - :xref_param_type:`other` :xref_param_type:`plotting` :xref_param_type:`keyword` :xref_param_type:`arguments` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pandas date offset or offset alias for identifying bin edges | | - :xref_param_type:`pandas` :xref_param_type:`date` :xref_param_type:`offset` or :xref_param_type:`offset` :xref_param_type:`alias` :xref_param_type:`for` :xref_param_type:`identifying` :xref_param_type:`bin` :xref_param_type:`edges` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pandas object | | - :xref_param_type:`pandas` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pandas_dtype | | - :xref_param_type:`pandas_dtype` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pandas_dtype / np.dtype | | - :xref_param_type:`pandas_dtype` / :xref_param_type:`np.dtype` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pandas_dtype, optional | | - :xref_param_type:`pandas_dtype`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - passed value | | - :xref_param_type:`passed` :xref_param_type:`value` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - path | | - :xref_param_type:`path` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - path (string), buffer or path object (pathlib.Path or | | - :xref_param_type:`path` (:xref_param_type:`string `), :xref_param_type:`buffer` or :xref_param_type:`path` :xref_param_type:`object` (:xref_param_type:`pathlib.Path` :xref_param_type:`or` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - path name or buffer | | - :xref_param_type:`path` :xref_param_type:`name` or :xref_param_type:`buffer` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pd.HolidayCalendar or np.busdaycalendar | | - :xref_param_type:`pd.HolidayCalendar` or :xref_param_type:`np.busdaycalendar` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pd.Index | | - :xref_param_type:`pd.Index` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pd.MultiIndex | | - :xref_param_type:`pd.MultiIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pd.Series | | - :xref_param_type:`pd.Series` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - perform inplace modification, default is False | | - :xref_param_type:`perform` :xref_param_type:`inplace` :xref_param_type:`modification`, default :xref_param_type:`is` :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - possibly a callable | | - :xref_param_type:`possibly` :xref_param_type:`a` :xref_param_type:`callable` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - pytz.timezone or dateutil.tz.tzfile | | - :xref_param_type:`pytz.timezone` or :xref_param_type:`dateutil.tz.tzfile` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - raise on invalid input | | - :xref_param_type:`raise` :xref_param_type:`on` :xref_param_type:`invalid` :xref_param_type:`input` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - recarray | | - :xref_param_type:`recarray` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - regex | | - :xref_param_type:`regex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - replace NaN with this value if the unstack produces | | - :xref_param_type:`replace` :xref_param_type:`NaN` :xref_param_type:`with` :xref_param_type:`this` :xref_param_type:`value` :xref_param_type:`if` :xref_param_type:`the` :xref_param_type:`unstack` :xref_param_type:`produces` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - row label | | - :xref_param_type:`row` :xref_param_type:`label` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - same as input object | | - :xref_param_type:`same` :xref_param_type:`as` :xref_param_type:`input` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - same type as caller | | - :xref_param_type:`same` :xref_param_type:`type` :xref_param_type:`as` :xref_param_type:`caller` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - same types as can be passed to DataFrame or scipy.sparse.spmatrix | | - :xref_param_type:`same` :xref_param_type:`types` :xref_param_type:`as` :xref_param_type:`can` :xref_param_type:`be` :xref_param_type:`passed` :xref_param_type:`to` :xref_param_type:`DataFrame ` or :xref_param_type:`scipy.sparse.spmatrix` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar | | - :xref_param_type:`scalar` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar (int) or Series (slice, sequence) | | - :xref_param_type:`scalar` (:xref_param_type:`int`) :xref_param_type:`or` :xref_param_type:`Series ` (:xref_param_type:`slice`, :term:`python:sequence`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar item to coerce | | - :xref_param_type:`scalar` :xref_param_type:`item` :xref_param_type:`to` :xref_param_type:`coerce` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or Series | | - :xref_param_type:`scalar` or :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array | | - :xref_param_type:`scalar` or :xref_param_type:`array ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array_like | | - :xref_param_type:`scalar` or :term:`numpy:array_like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or array_like, optional | | - :xref_param_type:`scalar` or :term:`numpy:array_like`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar or ndarray | | - :xref_param_type:`scalar` or :xref_param_type:`ndarray ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar value | | - :xref_param_type:`scalar` :xref_param_type:`value` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, Series, or array-like | | - :xref_param_type:`scalar`, :xref_param_type:`Series `, :xref_param_type:`or` :term:`array-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, default is 'unix' | | - :xref_param_type:`scalar`, default :xref_param_type:`is` 'unix' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, dict, Series | | - :xref_param_type:`scalar`, :xref_param_type:`dict`, :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, dict, list, str, regex, default None | | - :xref_param_type:`scalar`, :xref_param_type:`dict`, :xref_param_type:`list`, :xref_param_type:`str`, :xref_param_type:`regex`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, hashable sequence, dict-like or function, optional | | - :xref_param_type:`scalar`, :xref_param_type:`hashable` :term:`python:sequence`, dict-like or :xref_param_type:`function`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, list-like, optional | | - :xref_param_type:`scalar`, list-like, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scalar, str, list-like, or dict, default None | | - :xref_param_type:`scalar`, :xref_param_type:`str`, list-like, :xref_param_type:`or` :xref_param_type:`dict`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - scipy.sparse.coo_matrix | | - :xref_param_type:`scipy.sparse.coo_matrix` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - separator character to use | | - :xref_param_type:`separator` :xref_param_type:`character` :xref_param_type:`to` :xref_param_type:`use` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence | | - :term:`python:sequence` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of (key, value) pairs | | - :term:`python:sequence` :xref_param_type:`of` (:xref_param_type:`key`, :xref_param_type:`value`) :xref_param_type:`pairs` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of arrays | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`arrays` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of column labels, optional | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`column` :xref_param_type:`labels`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of sequences | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`sequences` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of str | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`str` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence of strings | | - :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`strings ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence or list of sequence | | - :term:`python:sequence` or :xref_param_type:`list` :xref_param_type:`of` :term:`python:sequence` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence, default | | - :term:`python:sequence`, default | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence, default None | | - :term:`python:sequence`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sequence, optional | | - :term:`python:sequence`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - set | | - :xref_param_type:`set` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - set of to_concat dtypes | | - :xref_param_type:`set` :xref_param_type:`of` :xref_param_type:`to_concat` :xref_param_type:`dtypes` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - set or list-like | | - :xref_param_type:`set` or list-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - set or sequence of values | | - :xref_param_type:`set` or :term:`python:sequence` :xref_param_type:`of` :xref_param_type:`values` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - setup the axis properties (default True) | | - :xref_param_type:`setup` :xref_param_type:`the` :xref_param_type:`axis` :xref_param_type:`properties` (default :xref_param_type:`True`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - single SQLtype or dict of column name to SQL type, default None | | - :xref_param_type:`single` :xref_param_type:`SQLtype` or :xref_param_type:`dict` :xref_param_type:`of` :xref_param_type:`column` :xref_param_type:`name` :xref_param_type:`to` :xref_param_type:`SQL` :xref_param_type:`type`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - single label or list-like | | - :xref_param_type:`single` :xref_param_type:`label` or list-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - single tuple | | - :xref_param_type:`single` :xref_param_type:`tuple` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - single type or dict of column name to SQL type, default None | | - :xref_param_type:`single` :xref_param_type:`type` or :xref_param_type:`dict` :xref_param_type:`of` :xref_param_type:`column` :xref_param_type:`name` :xref_param_type:`to` :xref_param_type:`SQL` :xref_param_type:`type`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - slice | | - :xref_param_type:`slice` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - some index contained in the index | | - :xref_param_type:`some` :xref_param_type:`index` :xref_param_type:`contained` :xref_param_type:`in` :xref_param_type:`the` :xref_param_type:`index` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sort by the remaining levels after level. | | - :xref_param_type:`sort` :xref_param_type:`by` :xref_param_type:`the` :xref_param_type:`remaining` :xref_param_type:`levels` :xref_param_type:`after` level. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - sqlite connection object | | - :xref_param_type:`sqlite` :xref_param_type:`connection` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - stack trace object | | - :xref_param_type:`stack` :xref_param_type:`trace` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - starting date, datetime-like, optional | | - :xref_param_type:`starting` :xref_param_type:`date`, datetime-like, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - starting value, datetime-like, optional | | - :xref_param_type:`starting` :xref_param_type:`value`, datetime-like, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - starting value, period-like, optional | | - :xref_param_type:`starting` :xref_param_type:`value`, period-like, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - starting value, timedelta-like, optional | | - :xref_param_type:`starting` :xref_param_type:`value`, timedelta-like, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str | | - :xref_param_type:`str` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str (optional) | | - :xref_param_type:`str` (optional) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or None | | - :xref_param_type:`str` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or None, container of strings | | - :xref_param_type:`str` or :xref_param_type:`None`, :xref_param_type:`container` :xref_param_type:`of` :xref_param_type:`strings ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or None, optional | | - :xref_param_type:`str` or :xref_param_type:`None`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or PeriodDtype, default None | | - :xref_param_type:`str` or :xref_param_type:`PeriodDtype`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or buffer | | - :xref_param_type:`str` or :xref_param_type:`buffer` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or compiled regular expression, optional | | - :xref_param_type:`str` or :xref_param_type:`compiled` :xref_param_type:`regular` :xref_param_type:`expression`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or csv.Dialect instance, default None | | - :xref_param_type:`str` or :xref_param_type:`csv.Dialect` :xref_param_type:`instance`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or file-like | | - :xref_param_type:`str` or :term:`file-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or int, optional | | - :xref_param_type:`str` or :xref_param_type:`int`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or list | | - :xref_param_type:`str` or :xref_param_type:`list` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or list of str | | - :xref_param_type:`str` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`str` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or list-like | | - :xref_param_type:`str` or list-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or list-like which has the same length as texts | | - :xref_param_type:`str` or list-like :xref_param_type:`which` :xref_param_type:`has` :xref_param_type:`the` :xref_param_type:`same` :xref_param_type:`length` :xref_param_type:`as` :xref_param_type:`texts` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or ndarray-like, optional | | - :xref_param_type:`str` or ndarray-like, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or numpy.dtype | | - :xref_param_type:`str` or :xref_param_type:`numpy.dtype` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or regex | | - :xref_param_type:`str` or :xref_param_type:`regex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or regular expression | | - :xref_param_type:`str` or :xref_param_type:`regular` :xref_param_type:`expression` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or sequence | | - :xref_param_type:`str` or :term:`python:sequence` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or tuple | | - :xref_param_type:`str` or :xref_param_type:`tuple` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str or unicode | | - :xref_param_type:`str` or :xref_param_type:`unicode` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'E', 'S'} | | - :xref_param_type:`str` {'E', 'S'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str {'dict', 'list', 'series', 'split', 'records', 'index'} | | - :xref_param_type:`str` {'dict', 'list', 'series', 'split', 'records', 'index'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, Default 'Mon Tue Wed Thu Fri' | | - :xref_param_type:`str`, :xref_param_type:`Default` 'Mon :xref_param_type:`Tue` :xref_param_type:`Wed` :xref_param_type:`Thu` Fri' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, array-like | | - :xref_param_type:`str`, :term:`array-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default "" | | - :xref_param_type:`str`, default "" | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default '.' | | - :xref_param_type:`str`, default '.' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default 'Attributes' | | - :xref_param_type:`str`, default 'Attributes' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default 'Categorical' | | - :xref_param_type:`str`, default 'Categorical' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default 'DataFrame' | | - :xref_param_type:`str`, default 'DataFrame' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default 'Index' | | - :xref_param_type:`str`, default 'Index' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default 'Panel' | | - :xref_param_type:`str`, default 'Panel' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default 'Series' | | - :xref_param_type:`str`, default 'Series' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default 'SparseDataFrame' | | - :xref_param_type:`str`, default 'SparseDataFrame' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default 'SparseSeries' | | - :xref_param_type:`str`, default 'SparseSeries' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default '\\d+' | | - :xref_param_type:`str`, default '\\d+' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default '\s+'. | | - :xref_param_type:`str`, default '\s+'. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default 'numpy array' | | - :xref_param_type:`str`, default 'numpy array' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default None | | - :xref_param_type:`str`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, default is 'utf-8' | | - :xref_param_type:`str`, default :xref_param_type:`is` 'utf-8' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, dict | | - :xref_param_type:`str`, :xref_param_type:`dict` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, method of resampling ('ffill', 'bfill') | | - :xref_param_type:`str`, :xref_param_type:`method` :xref_param_type:`of` :xref_param_type:`resampling` ('ffill', 'bfill') | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, optional | | - :xref_param_type:`str`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, optional (python 2) | | - :xref_param_type:`str`, optional (:xref_param_type:`python` 2) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, optional, default 'numexpr' | | - :xref_param_type:`str`, optional, default 'numexpr' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, optional, default 'pandas' | | - :xref_param_type:`str`, optional, default 'pandas' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, regex, list, dict, Series, numeric, or None | | - :xref_param_type:`str`, :xref_param_type:`regex`, :xref_param_type:`list`, :xref_param_type:`dict`, :xref_param_type:`Series `, :xref_param_type:`numeric`, :xref_param_type:`or` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, tuple, datetime.timedelta, DateOffset or None | | - :xref_param_type:`str`, :xref_param_type:`tuple`, :xref_param_type:`datetime.timedelta`, :xref_param_type:`DateOffset` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, unicode, or file-like | | - :xref_param_type:`str`, :xref_param_type:`unicode`, :xref_param_type:`or` :term:`file-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - str, {'raise', 'ignore'}, default 'raise' | | - :xref_param_type:`str`, {'raise', 'ignore'}, default 'raise' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string | | - :xref_param_type:`string ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string (if not buffer passed) | | - :xref_param_type:`string ` (:xref_param_type:`if` :xref_param_type:`not` :xref_param_type:`buffer` :xref_param_type:`passed`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string (length 1), default '\"' | | - :xref_param_type:`string ` (:xref_param_type:`length` 1), default '\"' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string (length 1), default None | | - :xref_param_type:`string ` (:xref_param_type:`length` 1), default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string (optional) | | - :xref_param_type:`string ` (optional) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string (regular expression) | | - :xref_param_type:`string ` (:xref_param_type:`regular` :xref_param_type:`expression`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string / cython mapped function | | - :xref_param_type:`string ` / :xref_param_type:`cython` :xref_param_type:`mapped` :xref_param_type:`function` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string / dtype | | - :xref_param_type:`string ` / :xref_param_type:`dtype ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string / frequency object, defaults to None | | - :xref_param_type:`string ` / :xref_param_type:`frequency` :xref_param_type:`object`, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string / list of selections | | - :xref_param_type:`string ` / :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`selections` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string File path, BytesIO like or string | | - :xref_param_type:`string ` :xref_param_type:`File` :xref_param_type:`path`, :xref_param_type:`BytesIO` :xref_param_type:`like` or :xref_param_type:`string ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string File path, buffer-like, or None | | - :xref_param_type:`string ` :xref_param_type:`File` :xref_param_type:`path`, buffer-like, :xref_param_type:`or` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string SQL query or SQLAlchemy Selectable (select or text object) | | - :xref_param_type:`string ` :xref_param_type:`SQL` :xref_param_type:`query` or :xref_param_type:`SQLAlchemy` :xref_param_type:`Selectable` (:xref_param_type:`select` or :xref_param_type:`text` :xref_param_type:`object`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string file path or file handle / StringIO | | - :xref_param_type:`string ` :xref_param_type:`file` :xref_param_type:`path` or :xref_param_type:`file` :xref_param_type:`handle` / :xref_param_type:`StringIO` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string file path, or file-like object | | - :xref_param_type:`string ` :xref_param_type:`file` :xref_param_type:`path`, :xref_param_type:`or` :term:`file-like` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string in time format, datetime.time, list, tuple, 1-d array, Series | | - :xref_param_type:`string ` :xref_param_type:`in` :xref_param_type:`time` :xref_param_type:`format`, :xref_param_type:`datetime.time`, :xref_param_type:`list`, :xref_param_type:`tuple`, 1-d :xref_param_type:`array `, :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string key to encode, default to _default_hash_key | | - :xref_param_type:`string ` :xref_param_type:`key` :xref_param_type:`to` :xref_param_type:`encode`, default :xref_param_type:`to` :xref_param_type:`_default_hash_key` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string list of accessors to add | | - :xref_param_type:`string ` :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`accessors` :xref_param_type:`to` :xref_param_type:`add` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or DateOffset object, optional (default None) | | - :xref_param_type:`string ` or :xref_param_type:`DateOffset` :xref_param_type:`object`, optional (default :xref_param_type:`None`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or DateOffset, default 'B' (business daily) | | - :xref_param_type:`string ` or :xref_param_type:`DateOffset`, default 'B' (:xref_param_type:`business` :xref_param_type:`daily`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or DateOffset, default 'C' (CustomBusinessDay) | | - :xref_param_type:`string ` or :xref_param_type:`DateOffset`, default 'C' (:xref_param_type:`CustomBusinessDay`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or DateOffset, default 'D' (calendar daily) | | - :xref_param_type:`string ` or :xref_param_type:`DateOffset`, default 'D' (:xref_param_type:`calendar` :xref_param_type:`daily`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or DateOffset, optional | | - :xref_param_type:`string ` or :xref_param_type:`DateOffset`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or ExcelWriter object | | - :xref_param_type:`string ` or :xref_param_type:`ExcelWriter` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or None | | - :xref_param_type:`string ` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or None, default 'numexpr', {'python', 'numexpr'} | | - :xref_param_type:`string ` or :xref_param_type:`None`, default 'numexpr', {'python', 'numexpr'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or None, default None | | - :xref_param_type:`string ` or :xref_param_type:`None`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or SQLAlchemy Selectable (select or text object) | | - :xref_param_type:`string ` or :xref_param_type:`SQLAlchemy` :xref_param_type:`Selectable` (:xref_param_type:`select` or :xref_param_type:`text` :xref_param_type:`object`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or callable | | - :xref_param_type:`string ` or :xref_param_type:`callable` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or compiled regex | | - :xref_param_type:`string ` or :xref_param_type:`compiled` :xref_param_type:`regex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or datetime-like, default None | | - :xref_param_type:`string ` or datetime-like, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or file handle, default None | | - :xref_param_type:`string ` or :xref_param_type:`file` :xref_param_type:`handle`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or file-like object | | - :xref_param_type:`string ` or :term:`file-like` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or int, optional | | - :xref_param_type:`string ` or :xref_param_type:`int`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or list of strings, default None | | - :xref_param_type:`string ` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings `, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or list of strings, optional, default: None | | - :xref_param_type:`string ` or :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings `, optional, default: :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or np.dtype | | - :xref_param_type:`string ` or :xref_param_type:`np.dtype` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or object | | - :xref_param_type:`string ` or :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or object, optional | | - :xref_param_type:`string ` or :xref_param_type:`object`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or pandas offset object, optional | | - :xref_param_type:`string ` or :xref_param_type:`pandas` :xref_param_type:`offset` :xref_param_type:`object`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or period object, optional | | - :xref_param_type:`string ` or :xref_param_type:`period` :xref_param_type:`object`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or period-like, default None | | - :xref_param_type:`string ` or period-like, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or pytz.timezone object | | - :xref_param_type:`string ` or :xref_param_type:`pytz.timezone` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or sequence | | - :xref_param_type:`string ` or :term:`python:sequence` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or sequence, default None | | - :xref_param_type:`string ` or :term:`python:sequence`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or sequence, default: None | | - :xref_param_type:`string ` or :term:`python:sequence`, default: :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or sequence, or False, default None | | - :xref_param_type:`string ` or :term:`python:sequence`, :xref_param_type:`or` :xref_param_type:`False`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or timedelta-like, default None | | - :xref_param_type:`string ` or timedelta-like, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string or tuple | | - :xref_param_type:`string ` or :xref_param_type:`tuple` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string term expression, Expr, or list-like of Exprs | | - :xref_param_type:`string ` :xref_param_type:`term` :xref_param_type:`expression`, :xref_param_type:`Expr`, :xref_param_type:`or` list-like :xref_param_type:`of` :xref_param_type:`Exprs` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string tz that this represents | | - :xref_param_type:`string ` :xref_param_type:`tz` :xref_param_type:`that` :xref_param_type:`this` :xref_param_type:`represents` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string unit that this represents, currently must be 'ns' | | - :xref_param_type:`string ` :xref_param_type:`unit` :xref_param_type:`that` :xref_param_type:`this` :xref_param_type:`represents`, :xref_param_type:`currently` :xref_param_type:`must` :xref_param_type:`be` 'ns' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string {'xport', 'sas7bdat'} or None | | - :xref_param_type:`string ` {'xport', 'sas7bdat'} :xref_param_type:`or` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, | | - string, | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, DateOffset, dateutil.relativedelta | | - :xref_param_type:`string `, :xref_param_type:`DateOffset`, :xref_param_type:`dateutil.relativedelta` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, Default 'Mon Tue Wed Thu Fri' | | - :xref_param_type:`string `, :xref_param_type:`Default` 'Mon :xref_param_type:`Tue` :xref_param_type:`Wed` :xref_param_type:`Thu` Fri' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default | | - :xref_param_type:`string `, default | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default "Pandas" | | - :xref_param_type:`string `, default "Pandas" | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default "|" | | - :xref_param_type:`string `, default "|" | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default '' | | - :xref_param_type:`string `, default '' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default ',' | | - :xref_param_type:`string `, default ',' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default '.' | | - :xref_param_type:`string `, default '.' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default 'All' | | - :xref_param_type:`string `, default 'All' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default '_' | | - :xref_param_type:`string `, default '_' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default 'mean' | | - :xref_param_type:`string `, default 'mean' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default 'ms' (milliseconds) | | - :xref_param_type:`string `, default 'ms' (:xref_param_type:`milliseconds`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default 'ns' | | - :xref_param_type:`string `, default 'ns' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default 'pandas', {'pandas', 'python'} | | - :xref_param_type:`string `, default 'pandas', {'pandas', 'python'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default 'utf8' | | - :xref_param_type:`string `, default 'utf8' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default None | | - :xref_param_type:`string `, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default `'inf'` | | - :xref_param_type:`string `, default `'inf'` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default ``'\n'`` | | - :xref_param_type:`string `, default ``'\n'`` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default frequency of PeriodIndex | | - :xref_param_type:`string `, default :xref_param_type:`frequency` :xref_param_type:`of` :xref_param_type:`PeriodIndex` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, default is None | | - :xref_param_type:`string `, default :xref_param_type:`is` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, defaults to None | | - :xref_param_type:`string `, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, dict, function | | - :xref_param_type:`string `, :xref_param_type:`dict`, :xref_param_type:`function` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, list of fields, array-like | | - :xref_param_type:`string `, :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`fields`, :term:`array-like` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, list of strings, or dict of strings, default None | | - :xref_param_type:`string `, :xref_param_type:`list` :xref_param_type:`of` :xref_param_type:`strings `, :xref_param_type:`or` :xref_param_type:`dict` :xref_param_type:`of` :xref_param_type:`strings `, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, number, or hashable object | | - :xref_param_type:`string `, :xref_param_type:`number`, :xref_param_type:`or` :xref_param_type:`hashable` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, optional | | - :xref_param_type:`string `, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, optional, default: None | | - :xref_param_type:`string `, optional, default: :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, optional, defaults None | | - :xref_param_type:`string `, optional, :xref_param_type:`defaults` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, optional, {'pad', 'ffill', 'bfill'} | | - :xref_param_type:`string `, optional, {'pad', 'ffill', 'bfill'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, path object (pathlib.Path or py._path.local.LocalPath), | | - :xref_param_type:`string `, :xref_param_type:`path` :xref_param_type:`object` (:xref_param_type:`pathlib.Path` or :xref_param_type:`py._path.local.LocalPath`), | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, pytz.timezone, dateutil.tz.tzfile or None | | - :xref_param_type:`string `, :xref_param_type:`pytz.timezone`, :xref_param_type:`dateutil.tz.tzfile` or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, the type of setting error | | - :xref_param_type:`string `, :xref_param_type:`the` :xref_param_type:`type` :xref_param_type:`of` :xref_param_type:`setting` :xref_param_type:`error` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, timedelta, list, tuple, 1-d array, or Series | | - :xref_param_type:`string `, :xref_param_type:`timedelta`, :xref_param_type:`list`, :xref_param_type:`tuple`, 1-d :xref_param_type:`array `, :xref_param_type:`or` :xref_param_type:`Series ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, valid regular expression | | - :xref_param_type:`string `, :xref_param_type:`valid` :xref_param_type:`regular` :xref_param_type:`expression` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string, {'r', 'r+', 'a'}, default 'r'. Mode to use when opening | | - :xref_param_type:`string `, {'r', 'r+', 'a'}, default 'r'. :xref_param_type:`Mode` :xref_param_type:`to` :xref_param_type:`use` :xref_param_type:`when` :xref_param_type:`opening` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string/callable to apply | | - string/callable :xref_param_type:`to` :xref_param_type:`apply` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string/dtype or None | | - string/dtype or :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - string/pickled tz object | | - string/pickled :xref_param_type:`tz` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - subclass of Styler | | - :xref_param_type:`subclass` :xref_param_type:`of` :xref_param_type:`Styler` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - text_type | | - :xref_param_type:`text_type` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the actual metadata | | - :xref_param_type:`the` :xref_param_type:`actual` :xref_param_type:`metadata` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the axis of the selector dimension (int) | | - :xref_param_type:`the` :xref_param_type:`axis` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`selector` :xref_param_type:`dimension` (:xref_param_type:`int`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the axis to convert | | - :xref_param_type:`the` :xref_param_type:`axis` :xref_param_type:`to` :xref_param_type:`convert` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the axis to localize | | - :xref_param_type:`the` :xref_param_type:`axis` :xref_param_type:`to` :xref_param_type:`localize` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the callable or function name to operate on at the block level | | - :xref_param_type:`the` :xref_param_type:`callable` or :xref_param_type:`function` :xref_param_type:`name` :xref_param_type:`to` :xref_param_type:`operate` :xref_param_type:`on` :xref_param_type:`at` :xref_param_type:`the` :xref_param_type:`block` :xref_param_type:`level` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the class to add the methods/properties to | | - :xref_param_type:`the` :term:`python:class` :xref_param_type:`to` :xref_param_type:`add` :xref_param_type:`the` methods/properties :xref_param_type:`to` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the class to get methods/properties & doc-strings | | - :xref_param_type:`the` :term:`python:class` :xref_param_type:`to` :xref_param_type:`get` methods/properties & doc-strings | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the columns I want back | | - :xref_param_type:`the` :xref_param_type:`columns` :xref_param_type:`I` :xref_param_type:`want` :xref_param_type:`back` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the dtype of the Interval | | - :xref_param_type:`the` :xref_param_type:`dtype ` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`Interval` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the encoding of the data, optional | | - :xref_param_type:`the` :xref_param_type:`encoding` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`data`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the encoding to use to decode py3 bytes, default is 'utf-8' | | - :xref_param_type:`the` :xref_param_type:`encoding` :xref_param_type:`to` :xref_param_type:`use` :xref_param_type:`to` :xref_param_type:`decode` :xref_param_type:`py3` :xref_param_type:`bytes`, default :xref_param_type:`is` 'utf-8' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the indexer to the original array | | - :xref_param_type:`the` :xref_param_type:`indexer` :xref_param_type:`to` :xref_param_type:`the` :xref_param_type:`original` :xref_param_type:`array ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the label list | | - :xref_param_type:`the` :xref_param_type:`label` :xref_param_type:`list` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the names of the axes in order (lowest to highest) | | - :xref_param_type:`the` :xref_param_type:`names` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`axes` :xref_param_type:`in` :xref_param_type:`order` (:xref_param_type:`lowest` :xref_param_type:`to` :xref_param_type:`highest`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the ndarray like converted values | | - :xref_param_type:`the` :xref_param_type:`ndarray ` :xref_param_type:`like` :xref_param_type:`converted` :xref_param_type:`values` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the ndarray that we want to maybe upcast | | - :xref_param_type:`the` :xref_param_type:`ndarray ` :xref_param_type:`that` :xref_param_type:`we` :xref_param_type:`want` :xref_param_type:`to` :xref_param_type:`maybe` :xref_param_type:`upcast` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the number of axis for the default stats (int) | | - :xref_param_type:`the` :xref_param_type:`number` :xref_param_type:`of` :xref_param_type:`axis` :xref_param_type:`for` :xref_param_type:`the` default :xref_param_type:`stats` (:xref_param_type:`int`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the object from which to get the attributes that we are going | | - :xref_param_type:`the` :xref_param_type:`object` :xref_param_type:`from` :xref_param_type:`which` :xref_param_type:`to` :xref_param_type:`get` :xref_param_type:`the` :xref_param_type:`attributes` :xref_param_type:`that` :xref_param_type:`we` :xref_param_type:`are` :xref_param_type:`going` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the object to be resampled | | - :xref_param_type:`the` :xref_param_type:`object` :xref_param_type:`to` :xref_param_type:`be` :xref_param_type:`resampled` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the object to write to the clipboard | | - :xref_param_type:`the` :xref_param_type:`object` :xref_param_type:`to` :xref_param_type:`write` :xref_param_type:`to` :xref_param_type:`the` :xref_param_type:`clipboard` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the passed chunking value (default is 50000) | | - :xref_param_type:`the` :xref_param_type:`passed` :xref_param_type:`chunking` :xref_param_type:`value` (default :xref_param_type:`is` 50000) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the passed kwargs | | - :xref_param_type:`the` :xref_param_type:`passed` :xref_param_type:`kwargs` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the passed start value (default is None) | | - :xref_param_type:`the` :xref_param_type:`passed` :xref_param_type:`start` :xref_param_type:`value` (default :xref_param_type:`is` :xref_param_type:`None`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the path (string) or HDFStore object | | - :xref_param_type:`the` :xref_param_type:`path` (:xref_param_type:`string `) :xref_param_type:`or` :xref_param_type:`HDFStore` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the path or buffer to write the result string | | - :xref_param_type:`the` :xref_param_type:`path` or :xref_param_type:`buffer` :xref_param_type:`to` :xref_param_type:`write` :xref_param_type:`the` :xref_param_type:`result` :xref_param_type:`string ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the reference store | | - :xref_param_type:`the` :xref_param_type:`reference` :xref_param_type:`store` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the return type of ``func``. | | - :xref_param_type:`the` :xref_param_type:`return` :xref_param_type:`type` :xref_param_type:`of` ``func``. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the rows to iterate on | | - :xref_param_type:`the` :xref_param_type:`rows` :xref_param_type:`to` :xref_param_type:`iterate` :xref_param_type:`on` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the split index of binlabels to group the item of axis | | - :xref_param_type:`the` :xref_param_type:`split` :xref_param_type:`index` :xref_param_type:`of` :xref_param_type:`binlabels` :xref_param_type:`to` :xref_param_type:`group` :xref_param_type:`the` :xref_param_type:`item` :xref_param_type:`of` :xref_param_type:`axis` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the storage repr of NaN, optional | | - :xref_param_type:`the` :xref_param_type:`storage` :xref_param_type:`repr` :xref_param_type:`of` :xref_param_type:`NaN`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the subject object | | - :xref_param_type:`the` :xref_param_type:`subject` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the table to apply the where criteria (defaults to keys[0] | | - :xref_param_type:`the` :xref_param_type:`table` :xref_param_type:`to` :xref_param_type:`apply` :xref_param_type:`the` :xref_param_type:`where` :xref_param_type:`criteria` (:xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`keys`\[0] | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the unique Index | | - :xref_param_type:`the` :xref_param_type:`unique` :xref_param_type:`Index` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the values to create the new Index, optional | | - :xref_param_type:`the` :xref_param_type:`values` :xref_param_type:`to` :xref_param_type:`create` :xref_param_type:`the` :xref_param_type:`new` :xref_param_type:`Index`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - the where of the query | | - :xref_param_type:`the` :xref_param_type:`where` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`query` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - timedelta | | - :xref_param_type:`timedelta` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - timedelta, default timedelta(0) | | - :xref_param_type:`timedelta`, default :xref_param_type:`timedelta`\(0) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - timedelta64/arrays of timedelta64 if parsing succeeded | | - timedelta64/arrays :xref_param_type:`of` :xref_param_type:`timedelta64` :xref_param_type:`if` :xref_param_type:`parsing` :xref_param_type:`succeeded` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tree-like | | - tree-like | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - try casting the results to the input type | | - :xref_param_type:`try` :xref_param_type:`casting` :xref_param_type:`the` :xref_param_type:`results` :xref_param_type:`to` :xref_param_type:`the` :xref_param_type:`input` :xref_param_type:`type` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple | | - :xref_param_type:`tuple` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple (optional) | | - :xref_param_type:`tuple` (optional) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of (ndarray, boolean) | | - :xref_param_type:`tuple` :xref_param_type:`of` (:xref_param_type:`ndarray `, :xref_param_type:`boolean `) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of 3 elements (ufunc, signature, domain) | | - :xref_param_type:`tuple` :xref_param_type:`of` 3 :xref_param_type:`elements` (:xref_param_type:`ufunc`, :xref_param_type:`signature`, :xref_param_type:`domain`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple of int, str | | - :xref_param_type:`tuple` :xref_param_type:`of` :xref_param_type:`int`, :xref_param_type:`str` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple or Exception | | - :xref_param_type:`tuple` or :xref_param_type:`Exception` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple, default None | | - :xref_param_type:`tuple`, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple, optional | | - :xref_param_type:`tuple`, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple, slice, scalar | | - :xref_param_type:`tuple`, :xref_param_type:`slice`, :xref_param_type:`scalar` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - tuple/list | | - tuple/list | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - typ | | - :xref_param_type:`typ` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - type | | - :xref_param_type:`type` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - type of caller | | - :xref_param_type:`type` :xref_param_type:`of` :xref_param_type:`caller` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - type of caller (new object) | | - :xref_param_type:`type` :xref_param_type:`of` :xref_param_type:`caller` (:xref_param_type:`new` :xref_param_type:`object`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - type of caller or None if inplace=True | | - :xref_param_type:`type` :xref_param_type:`of` :xref_param_type:`caller` or :xref_param_type:`None` :xref_param_type:`if` inplace=True | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - type of compressor (zlib or blosc), default to None (no | | - :xref_param_type:`type` :xref_param_type:`of` :xref_param_type:`compressor` (:xref_param_type:`zlib` or :xref_param_type:`blosc`), default :xref_param_type:`to` :xref_param_type:`None` (:xref_param_type:`no` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - type of input | | - :xref_param_type:`type` :xref_param_type:`of` :xref_param_type:`input` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - type of input argument | | - :xref_param_type:`type` :xref_param_type:`of` :xref_param_type:`input` :xref_param_type:`argument` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - type of items contained in object | | - :xref_param_type:`type` :xref_param_type:`of` :xref_param_type:`items` :xref_param_type:`contained` :xref_param_type:`in` :xref_param_type:`object` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - type of obj | | - :xref_param_type:`type` :xref_param_type:`of` :xref_param_type:`obj` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - type of object stored in file | | - :xref_param_type:`type` :xref_param_type:`of` :xref_param_type:`object` :xref_param_type:`stored` :xref_param_type:`in` :xref_param_type:`file` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - type of object to recover (series or frame), default 'frame' | | - :xref_param_type:`type` :xref_param_type:`of` :xref_param_type:`object` :xref_param_type:`to` :xref_param_type:`recover` (:xref_param_type:`series ` or :xref_param_type:`frame`), default 'frame' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - unary callable | | - :xref_param_type:`unary` :xref_param_type:`callable` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - unicode | | - :xref_param_type:`unicode` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - unit of the arg (D,h,m,s,ms,us,ns) denote the unit, which is an | | - :xref_param_type:`unit` :xref_param_type:`of` :xref_param_type:`the` :xref_param_type:`arg` (D,h,m,s,ms,us,ns) :xref_param_type:`denote` :xref_param_type:`the` :xref_param_type:`unit`, :xref_param_type:`which` :xref_param_type:`is` :xref_param_type:`an` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - updates the default attributes for this Index | | - :xref_param_type:`updates` :xref_param_type:`the` default :xref_param_type:`attributes` :xref_param_type:`for` :xref_param_type:`this` :xref_param_type:`Index` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - upper left cell column to dump data frame | | - :xref_param_type:`upper` :xref_param_type:`left` :xref_param_type:`cell` :xref_param_type:`column` :xref_param_type:`to` :xref_param_type:`dump` :xref_param_type:`data` :xref_param_type:`frame` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - upper left cell row to dump data frame | | - :xref_param_type:`upper` :xref_param_type:`left` :xref_param_type:`cell` :xref_param_type:`row` :xref_param_type:`to` :xref_param_type:`dump` :xref_param_type:`data` :xref_param_type:`frame` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - what we want to fill with | | - :xref_param_type:`what` :xref_param_type:`we` :xref_param_type:`want` :xref_param_type:`to` :xref_param_type:`fill` :xref_param_type:`with` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - where to reorder levels | | - :xref_param_type:`where` :xref_param_type:`to` :xref_param_type:`reorder` :xref_param_type:`levels` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - whether to try to use numexpr (default True) | | - :xref_param_type:`whether` :xref_param_type:`to` :xref_param_type:`try` :xref_param_type:`to` :xref_param_type:`use` :xref_param_type:`numexpr` (default :xref_param_type:`True`) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - which end of bin is closed; left (default), right | | - :xref_param_type:`which` :xref_param_type:`end` :xref_param_type:`of` :xref_param_type:`bin` :xref_param_type:`is` closed; :xref_param_type:`left` (default), :xref_param_type:`right` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - writable buffer, defaults to sys.stdout | | - :xref_param_type:`writable` :xref_param_type:`buffer`, :xref_param_type:`defaults` :xref_param_type:`to` :xref_param_type:`sys.stdout` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'NFC', 'NFKC', 'NFD', 'NFKD'} | | - {'NFC', 'NFKC', 'NFD', 'NFKD'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'a', 'w', 'r', 'r+'}, default 'a' | | - {'a', 'w', 'r', 'r+'}, default 'a' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'all', 'any'}, default 'any' | | - {'all', 'any'}, default 'any' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'any', 'all'} | | - {'any', 'all'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'auto', 'pyarrow', 'fastparquet'}, default 'auto' | | - {'auto', 'pyarrow', 'fastparquet'}, default 'auto' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'average', 'min', 'max', 'first', 'dense'} | | - {'average', 'min', 'max', 'first', 'dense'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'average', 'min', 'max', 'first', 'dense'}, default 'average' | | - {'average', 'min', 'max', 'first', 'dense'}, default 'average' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'backfill', 'bfill', 'pad', 'ffill', None}, default None | | - {'backfill', 'bfill', 'pad', 'ffill', :xref_param_type:`None`}, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'backfill'/'bfill', 'pad'/'ffill'}, default None | | - {'backfill'/'bfill', 'pad'/'ffill'}, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'block', 'integer'} | | - {'block', 'integer'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'block', 'integer'}, default 'block' | | - {'block', 'integer'}, default 'block' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'columns', 'index'}, default 'columns' | | - {'columns', 'index'}, default 'columns' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'fail', 'replace', 'append'}, default 'fail' | | - {'fail', 'replace', 'append'}, default 'fail' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'ffill', None}, default None | | - {'ffill', :xref_param_type:`None`}, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'first', 'last', False}, default 'first' | | - {'first', 'last', :xref_param_type:`False`}, default 'first' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'first', 'last'} (optional, default='last') | | - {'first', 'last'} (optional, default='last') | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'first', 'last'}, default 'first' | | - {'first', 'last'}, default 'first' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'fraction', 'lower', 'higher'}, optional | | - {'fraction', 'lower', 'higher'}, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'hist', 'kde'} | | - {'hist', 'kde'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'ignore', 'raise', 'coerce'}, default 'raise' | | - {'ignore', 'raise', 'coerce'}, default 'raise' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'ignore', 'raise'}, default 'raise' | | - {'ignore', 'raise'}, default 'raise' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'infer', 'gzip', 'bz2', 'xz', 'zip', None}, default 'infer' | | - {'infer', 'gzip', 'bz2', 'xz', 'zip', :xref_param_type:`None`}, default 'infer' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'infer', 'gzip', 'bz2', 'xz', None}, default 'infer' | | - {'infer', 'gzip', 'bz2', 'xz', :xref_param_type:`None`}, default 'infer' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'infer', 'gzip', 'bz2', 'zip', 'xz', None}, default 'infer' | | - {'infer', 'gzip', 'bz2', 'zip', 'xz', :xref_param_type:`None`}, default 'infer' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'inner', 'outer'}, default 'outer' | | - {'inner', 'outer'}, default 'outer' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'integer', 'signed', 'unsigned', 'float'} , default None | | - {'integer', 'signed', 'unsigned', 'float'} , default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'items', 'major', 'minor'} | | - {'items', 'major', 'minor'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'items', 'major', 'minor'} or {0, 1, 2} | | - {'items', 'major', 'minor'} :xref_param_type:`or` {0, 1, 2} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'items', 'major', 'minor}, default 1/'major' | | - {'items', 'major', 'minor}, default 1/'major' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'items', 'minor', 'major'}, or {0, 1, 2}, or a tuple with two | | - {'items', 'minor', 'major'}, :xref_param_type:`or` {0, 1, 2}, :xref_param_type:`or` :xref_param_type:`a` :xref_param_type:`tuple` :xref_param_type:`with` :xref_param_type:`two` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'items', 'minor'}, default 'items' | | - {'items', 'minor'}, default 'items' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'ix', 'loc', 'getitem', 'iloc'} or None | | - {'ix', 'loc', 'getitem', 'iloc'} :xref_param_type:`or` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'ix', 'loc', 'getitem'} | | - {'ix', 'loc', 'getitem'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'ix', 'loc', 'getitem'} or None | | - {'ix', 'loc', 'getitem'} :xref_param_type:`or` :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'keep', 'top', 'bottom'} | | - {'keep', 'top', 'bottom'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'keep', 'top'}, default 'keep' | | - {'keep', 'top'}, default 'keep' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'left', 'right', 'both', 'neither'}, default 'right' | | - {'left', 'right', 'both', 'neither'}, default 'right' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'left', 'right', 'both'}, default 'both' | | - {'left', 'right', 'both'}, default 'both' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'left', 'right', 'both'}, default 'left' | | - {'left', 'right', 'both'}, default 'left' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'left', 'right', 'outer', 'inner'} | | - {'left', 'right', 'outer', 'inner'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'left', 'right', 'outer', 'inner'}, default 'outer' | | - {'left', 'right', 'outer', 'inner'}, default 'outer' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'left', 'right', 'outer', 'inner'}, default: 'left' | | - {'left', 'right', 'outer', 'inner'}, default: 'left' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'left', 'right'} | | - {'left', 'right'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'left', 'right'}, default 'left' | | - {'left', 'right'}, default 'left' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'left', 'zero',' mid'}, default 'left' | | - {'left', 'zero',' mid'}, default 'left' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'left'}, default 'left' | | - {'left'}, default 'left' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'legacy', 'standard'}, default 'legacy' | | - {'legacy', 'standard'}, default 'legacy' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'linear', 'log'} | | - {'linear', 'log'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'linear', 'lower', 'higher', 'midpoint', 'nearest'} | | - {'linear', 'lower', 'higher', 'midpoint', 'nearest'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'major', 'minor', 'items'}, default 'major' | | - {'major', 'minor', 'items'}, default 'major' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'major', 'minor'}, default 'minor' | | - {'major', 'minor'}, default 'minor' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'mergesort', 'quicksort', 'heapsort'}, default 'quicksort' | | - {'mergesort', 'quicksort', 'heapsort'}, default 'quicksort' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'pearson', 'kendall', 'spearman'} | | - {'pearson', 'kendall', 'spearman'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'raise', 'ignore'}, default 'raise' | | - {'raise', 'ignore'}, default 'raise' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'raise', 'ignore'}, default 'raise'. | | - {'raise', 'ignore'}, default 'raise'. | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'right', 'left'} | | - {'right', 'left'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'s', 'e', 'start', 'end'} | | - {'s', 'e', 'start', 'end'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'snappy', 'gzip', 'brotli', 'None'} | | - {'snappy', 'gzip', 'brotli', 'None'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'start', 'end', 'e', 's'} | | - {'start', 'end', 'e', 's'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'start', 'end', 's', 'e'} | | - {'start', 'end', 's', 'e'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'start', 'end'}, default end | | - {'start', 'end'}, default :xref_param_type:`end` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {'zlib', 'lzo', 'bzip2', 'blosc'}, default 'zlib' | | - {'zlib', 'lzo', 'bzip2', 'blosc'}, default 'zlib' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0 or 'index', 1 or 'columns'} | | - {0 or 'index', 1 or 'columns'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0 or 'index', 1 or 'columns'}, default 0 | | - {0 or 'index', 1 or 'columns'}, default 0 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0 or 'index', 1 or 'columns'}, or tuple/list thereof | | - {0 or 'index', 1 or 'columns'}, :xref_param_type:`or` tuple/list :xref_param_type:`thereof` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0, 1, 'index', 'columns'} | | - {0, 1, 'index', 'columns'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0, 1, 'index', 'columns'} (default 0) | | - {0, 1, 'index', 'columns'} (default 0) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0, 1, ..., 6} | | - {0, 1, ..., 6} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0, 1, ..., 6}, default None | | - {0, 1, ..., 6}, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0, 1, 2, 3, ...}, default None | | - {0, 1, 2, 3, ...}, default :xref_param_type:`None` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0, 1} | | - {0, 1} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0, 1}, default 0 | | - {0, 1}, default 0 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0/'index', 1/'columns'}, default 0 | | - {0/'index', 1/'columns'}, default 0 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {0} | | - {0} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {BlockIndex, IntIndex} | | - {:xref_param_type:`BlockIndex`, :xref_param_type:`IntIndex`} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {BlockIndex, IntIndex}, optional | | - {:xref_param_type:`BlockIndex`, :xref_param_type:`IntIndex`}, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {False, True} | | - {:xref_param_type:`False`, :xref_param_type:`True`} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {False, True}, optional | | - {:xref_param_type:`False`, :xref_param_type:`True`}, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, 'epoch', 'iso'} | | - {:xref_param_type:`None`, 'epoch', 'iso'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, 'gzip', 'bz2', 'xz'} | | - {:xref_param_type:`None`, 'gzip', 'bz2', 'xz'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, 'ignore'} | | - {:xref_param_type:`None`, 'ignore'} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None, True, False}, optional | | - {:xref_param_type:`None`, :xref_param_type:`True`, :xref_param_type:`False`}, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None} | | - {:xref_param_type:`None`} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {None}, optional | | - {:xref_param_type:`None`}, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {Series, DataFrame, Panel} | | - {:xref_param_type:`Series `, :xref_param_type:`DataFrame `, :xref_param_type:`Panel`} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {True, False} | | - {:xref_param_type:`True`, :xref_param_type:`False`} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {True, False}, optional | | - {:xref_param_type:`True`, :xref_param_type:`False`}, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {True, False}, optional, default False | | - {:xref_param_type:`True`, :xref_param_type:`False`}, optional, default :xref_param_type:`False` | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {array-like (1-D), Series, SparseSeries, dict} | | - {:term:`array-like` (1-D), :xref_param_type:`Series `, :xref_param_type:`SparseSeries`, :xref_param_type:`dict`} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {array-like, Series, SparseSeries, dict} | | - {:term:`array-like`, :xref_param_type:`Series `, :xref_param_type:`SparseSeries`, :xref_param_type:`dict`} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {default 'raise', 'drop'}, optional | | - {default 'raise', 'drop'}, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {int, string} | | - {:xref_param_type:`int`, :xref_param_type:`string `} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {int}, optional | | - {:xref_param_type:`int`}, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {np.random.RandomState, int}, optional | | - {:xref_param_type:`np.random.RandomState`, :xref_param_type:`int`}, optional | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | - {var} | | - {:xref_param_type:`var`} | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+