.. currentmodule:: pandas .. _api: ************* API Reference ************* .. _api.functions: Input/Output ------------ Pickling ~~~~~~~~ .. autosummary:: :toctree: generated/ read_pickle Flat File ~~~~~~~~~ .. autosummary:: :toctree: generated/ read_table read_csv read_fwf read_msgpack Clipboard ~~~~~~~~~ .. autosummary:: :toctree: generated/ read_clipboard Excel ~~~~~ .. autosummary:: :toctree: generated/ read_excel ExcelFile.parse JSON ~~~~ .. autosummary:: :toctree: generated/ read_json .. currentmodule:: pandas.io.json .. autosummary:: :toctree: generated/ json_normalize .. currentmodule:: pandas HTML ~~~~ .. autosummary:: :toctree: generated/ read_html HDFStore: PyTables (HDF5) ~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ read_hdf HDFStore.put HDFStore.append HDFStore.get HDFStore.select Feather ~~~~~~~ .. autosummary:: :toctree: generated/ read_feather SAS ~~~ .. autosummary:: :toctree: generated/ read_sas SQL ~~~ .. autosummary:: :toctree: generated/ read_sql_table read_sql_query read_sql Google BigQuery ~~~~~~~~~~~~~~~ .. currentmodule:: pandas.io.gbq .. autosummary:: :toctree: generated/ read_gbq to_gbq .. currentmodule:: pandas STATA ~~~~~ .. autosummary:: :toctree: generated/ read_stata .. currentmodule:: pandas.io.stata .. autosummary:: :toctree: generated/ StataReader.data StataReader.data_label StataReader.value_labels StataReader.variable_labels StataWriter.write_file .. currentmodule:: pandas General functions ----------------- Data manipulations ~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ melt pivot pivot_table crosstab cut qcut merge merge_ordered merge_asof concat get_dummies factorize wide_to_long Top-level missing data ~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ isnull notnull Top-level conversions ~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ to_numeric Top-level dealing with datetimelike ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ to_datetime to_timedelta date_range bdate_range period_range timedelta_range infer_freq Top-level evaluation ~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ eval Testing ~~~~~~~ .. autosummary:: :toctree: generated/ test .. _api.series: Series ------ Constructor ~~~~~~~~~~~ .. currentmodule:: pandas .. autosummary:: :toctree: generated/ Series Attributes ~~~~~~~~~~ **Axes** * **index**: axis labels .. autosummary:: :toctree: generated/ Series.values Series.dtype Series.ftype Series.shape Series.nbytes Series.ndim Series.size Series.strides Series.itemsize Series.base Series.T Series.memory_usage Conversion ~~~~~~~~~~ .. autosummary:: :toctree: generated/ Series.astype Series.copy Series.isnull Series.notnull Indexing, iteration ~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Series.get Series.at Series.iat Series.loc Series.iloc Series.__iter__ Series.iteritems For more information on ``.at``, ``.iat``, ``.loc``, and ``.iloc``, see the :ref:`indexing documentation `. Binary operator functions ~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Series.add Series.sub Series.mul Series.div Series.truediv Series.floordiv Series.mod Series.pow Series.radd Series.rsub Series.rmul Series.rdiv Series.rtruediv Series.rfloordiv Series.rmod Series.rpow Series.combine Series.combine_first Series.round Series.lt Series.gt Series.le Series.ge Series.ne Series.eq Function application, GroupBy & Window ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Series.apply Series.map Series.groupby Series.rolling Series.expanding Series.ewm .. _api.series.stats: Computations / Descriptive Stats ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Series.abs Series.all Series.any Series.autocorr Series.between Series.clip Series.clip_lower Series.clip_upper Series.corr Series.count Series.cov Series.cummax Series.cummin Series.cumprod Series.cumsum Series.describe Series.diff Series.factorize Series.kurt Series.mad Series.max Series.mean Series.median Series.min Series.mode Series.nlargest Series.nsmallest Series.pct_change Series.prod Series.quantile Series.rank Series.sem Series.skew Series.std Series.sum Series.var Series.unique Series.nunique Series.is_unique Series.is_monotonic Series.is_monotonic_increasing Series.is_monotonic_decreasing Series.value_counts Reindexing / Selection / Label manipulation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Series.align Series.drop Series.drop_duplicates Series.duplicated Series.equals Series.first Series.head Series.idxmax Series.idxmin Series.isin Series.last Series.reindex Series.reindex_like Series.rename Series.rename_axis Series.reset_index Series.sample Series.select Series.take Series.tail Series.truncate Series.where Series.mask Missing data handling ~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Series.dropna Series.fillna Series.interpolate Reshaping, sorting ~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Series.argsort Series.reorder_levels Series.sort_values Series.sort_index Series.swaplevel Series.unstack Series.searchsorted Combining / joining / merging ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Series.append Series.replace Series.update Time series-related ~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Series.asfreq Series.asof Series.shift Series.first_valid_index Series.last_valid_index Series.resample Series.tz_convert Series.tz_localize Datetimelike Properties ~~~~~~~~~~~~~~~~~~~~~~~ ``Series.dt`` can be used to access the values of the series as datetimelike and return several properties. These can be accessed like ``Series.dt.``. **Datetime Properties** .. autosummary:: :toctree: generated/ :template: autosummary/accessor_attribute.rst Series.dt.date Series.dt.time Series.dt.year Series.dt.month Series.dt.day Series.dt.hour Series.dt.minute Series.dt.second Series.dt.microsecond Series.dt.nanosecond Series.dt.week Series.dt.weekofyear Series.dt.dayofweek Series.dt.weekday Series.dt.weekday_name Series.dt.dayofyear Series.dt.quarter Series.dt.is_month_start Series.dt.is_month_end Series.dt.is_quarter_start Series.dt.is_quarter_end Series.dt.is_year_start Series.dt.is_year_end Series.dt.is_leap_year Series.dt.daysinmonth Series.dt.days_in_month Series.dt.tz Series.dt.freq **Datetime Methods** .. autosummary:: :toctree: generated/ :template: autosummary/accessor_method.rst Series.dt.to_period Series.dt.to_pydatetime Series.dt.tz_localize Series.dt.tz_convert Series.dt.normalize Series.dt.strftime Series.dt.round Series.dt.floor Series.dt.ceil **Timedelta Properties** .. autosummary:: :toctree: generated/ :template: autosummary/accessor_attribute.rst Series.dt.days Series.dt.seconds Series.dt.microseconds Series.dt.nanoseconds Series.dt.components **Timedelta Methods** .. autosummary:: :toctree: generated/ :template: autosummary/accessor_method.rst Series.dt.to_pytimedelta Series.dt.total_seconds String handling ~~~~~~~~~~~~~~~ ``Series.str`` can be used to access the values of the series as strings and apply several methods to it. These can be accessed like ``Series.str.``. .. autosummary:: :toctree: generated/ :template: autosummary/accessor_method.rst Series.str.capitalize Series.str.cat Series.str.center Series.str.contains Series.str.count Series.str.decode Series.str.encode Series.str.endswith Series.str.extract Series.str.extractall Series.str.find Series.str.findall Series.str.get Series.str.index Series.str.join Series.str.len Series.str.ljust Series.str.lower Series.str.lstrip Series.str.match Series.str.normalize Series.str.pad Series.str.partition Series.str.repeat Series.str.replace Series.str.rfind Series.str.rindex Series.str.rjust Series.str.rpartition Series.str.rstrip Series.str.slice Series.str.slice_replace Series.str.split Series.str.rsplit Series.str.startswith Series.str.strip Series.str.swapcase Series.str.title Series.str.translate Series.str.upper Series.str.wrap Series.str.zfill Series.str.isalnum Series.str.isalpha Series.str.isdigit Series.str.isspace Series.str.islower Series.str.isupper Series.str.istitle Series.str.isnumeric Series.str.isdecimal Series.str.get_dummies .. The following is needed to ensure the generated pages are created with the correct template (otherwise they would be created in the Series/Index class page) .. .. autosummary:: :toctree: generated/ :template: autosummary/accessor.rst Series.str Series.cat Series.dt Index.str CategoricalIndex.str MultiIndex.str DatetimeIndex.str TimedeltaIndex.str .. _api.categorical: Categorical ~~~~~~~~~~~ If the Series is of dtype ``category``, ``Series.cat`` can be used to change the the categorical data. This accessor is similar to the ``Series.dt`` or ``Series.str`` and has the following usable methods and properties: .. autosummary:: :toctree: generated/ :template: autosummary/accessor_attribute.rst Series.cat.categories Series.cat.ordered Series.cat.codes .. autosummary:: :toctree: generated/ :template: autosummary/accessor_method.rst Series.cat.rename_categories Series.cat.reorder_categories Series.cat.add_categories Series.cat.remove_categories Series.cat.remove_unused_categories Series.cat.set_categories Series.cat.as_ordered Series.cat.as_unordered To create a Series of dtype ``category``, use ``cat = s.astype("category")``. The following two ``Categorical`` constructors are considered API but should only be used when adding ordering information or special categories is need at creation time of the categorical data: .. autosummary:: :toctree: generated/ :template: autosummary/class_without_autosummary.rst Categorical .. autosummary:: :toctree: generated/ Categorical.from_codes ``np.asarray(categorical)`` works by implementing the array interface. Be aware, that this converts the Categorical back to a numpy array, so levels and order information is not preserved! .. autosummary:: :toctree: generated/ Categorical.__array__ Plotting ~~~~~~~~ ``Series.plot`` is both a callable method and a namespace attribute for specific plotting methods of the form ``Series.plot.``. .. autosummary:: :toctree: generated/ :template: autosummary/accessor_callable.rst Series.plot .. autosummary:: :toctree: generated/ :template: autosummary/accessor_method.rst Series.plot.area Series.plot.bar Series.plot.barh Series.plot.box Series.plot.density Series.plot.hist Series.plot.kde Series.plot.line Series.plot.pie .. autosummary:: :toctree: generated/ Series.hist Serialization / IO / Conversion ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Series.from_csv Series.to_pickle Series.to_csv Series.to_dict Series.to_excel Series.to_frame Series.to_xarray Series.to_hdf Series.to_sql Series.to_msgpack Series.to_json Series.to_sparse Series.to_dense Series.to_string Series.to_clipboard Sparse methods ~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ SparseSeries.to_coo SparseSeries.from_coo .. _api.dataframe: DataFrame --------- Constructor ~~~~~~~~~~~ .. autosummary:: :toctree: generated/ DataFrame Attributes and underlying data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **Axes** * **index**: row labels * **columns**: column labels .. autosummary:: :toctree: generated/ DataFrame.as_matrix DataFrame.dtypes DataFrame.ftypes DataFrame.get_dtype_counts DataFrame.get_ftype_counts DataFrame.select_dtypes DataFrame.values DataFrame.axes DataFrame.ndim DataFrame.size DataFrame.shape DataFrame.memory_usage Conversion ~~~~~~~~~~ .. autosummary:: :toctree: generated/ DataFrame.astype DataFrame.convert_objects DataFrame.copy DataFrame.isnull DataFrame.notnull Indexing, iteration ~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ DataFrame.head DataFrame.at DataFrame.iat DataFrame.loc DataFrame.iloc DataFrame.insert DataFrame.__iter__ DataFrame.iteritems DataFrame.iterrows DataFrame.itertuples DataFrame.lookup DataFrame.pop DataFrame.tail DataFrame.xs DataFrame.isin DataFrame.where DataFrame.mask DataFrame.query For more information on ``.at``, ``.iat``, ``.loc``, and ``.iloc``, see the :ref:`indexing documentation `. Binary operator functions ~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ DataFrame.add DataFrame.sub DataFrame.mul DataFrame.div DataFrame.truediv DataFrame.floordiv DataFrame.mod DataFrame.pow DataFrame.radd DataFrame.rsub DataFrame.rmul DataFrame.rdiv DataFrame.rtruediv DataFrame.rfloordiv DataFrame.rmod DataFrame.rpow DataFrame.lt DataFrame.gt DataFrame.le DataFrame.ge DataFrame.ne DataFrame.eq DataFrame.combine DataFrame.combine_first Function application, GroupBy & Window ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ DataFrame.apply DataFrame.applymap DataFrame.groupby DataFrame.rolling DataFrame.expanding DataFrame.ewm .. _api.dataframe.stats: Computations / Descriptive Stats ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ DataFrame.abs DataFrame.all DataFrame.any DataFrame.clip DataFrame.clip_lower DataFrame.clip_upper DataFrame.corr DataFrame.corrwith DataFrame.count DataFrame.cov DataFrame.cummax DataFrame.cummin DataFrame.cumprod DataFrame.cumsum DataFrame.describe DataFrame.diff DataFrame.eval DataFrame.kurt DataFrame.mad DataFrame.max DataFrame.mean DataFrame.median DataFrame.min DataFrame.mode DataFrame.pct_change DataFrame.prod DataFrame.quantile DataFrame.rank DataFrame.round DataFrame.sem DataFrame.skew DataFrame.sum DataFrame.std DataFrame.var Reindexing / Selection / Label manipulation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ DataFrame.add_prefix DataFrame.add_suffix DataFrame.align DataFrame.drop DataFrame.drop_duplicates DataFrame.duplicated DataFrame.equals DataFrame.filter DataFrame.first DataFrame.head DataFrame.idxmax DataFrame.idxmin DataFrame.last DataFrame.reindex DataFrame.reindex_axis DataFrame.reindex_like DataFrame.rename DataFrame.rename_axis DataFrame.reset_index DataFrame.sample DataFrame.select DataFrame.set_index DataFrame.tail DataFrame.take DataFrame.truncate .. _api.dataframe.missing: Missing data handling ~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ DataFrame.dropna DataFrame.fillna DataFrame.replace Reshaping, sorting, transposing ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ DataFrame.pivot DataFrame.reorder_levels DataFrame.sort_values DataFrame.sort_index DataFrame.nlargest DataFrame.nsmallest DataFrame.swaplevel DataFrame.stack DataFrame.unstack DataFrame.T DataFrame.to_panel DataFrame.to_xarray DataFrame.transpose Combining / joining / merging ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ DataFrame.append DataFrame.assign DataFrame.join DataFrame.merge DataFrame.update Time series-related ~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ DataFrame.asfreq DataFrame.asof DataFrame.shift DataFrame.first_valid_index DataFrame.last_valid_index DataFrame.resample DataFrame.to_period DataFrame.to_timestamp DataFrame.tz_convert DataFrame.tz_localize .. _api.dataframe.plotting: Plotting ~~~~~~~~ ``DataFrame.plot`` is both a callable method and a namespace attribute for specific plotting methods of the form ``DataFrame.plot.``. .. autosummary:: :toctree: generated/ :template: autosummary/accessor_callable.rst DataFrame.plot .. autosummary:: :toctree: generated/ :template: autosummary/accessor_method.rst DataFrame.plot.area DataFrame.plot.bar DataFrame.plot.barh DataFrame.plot.box DataFrame.plot.density DataFrame.plot.hexbin DataFrame.plot.hist DataFrame.plot.kde DataFrame.plot.line DataFrame.plot.pie DataFrame.plot.scatter .. autosummary:: :toctree: generated/ DataFrame.boxplot DataFrame.hist Serialization / IO / Conversion ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ DataFrame.from_csv DataFrame.from_dict DataFrame.from_items DataFrame.from_records DataFrame.info DataFrame.to_pickle DataFrame.to_csv DataFrame.to_hdf DataFrame.to_sql DataFrame.to_dict DataFrame.to_excel DataFrame.to_json DataFrame.to_html DataFrame.to_feather DataFrame.to_latex DataFrame.to_stata DataFrame.to_msgpack DataFrame.to_gbq DataFrame.to_records DataFrame.to_sparse DataFrame.to_dense DataFrame.to_string DataFrame.to_clipboard .. _api.panel: Panel ------ Constructor ~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel Attributes and underlying data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **Axes** * **items**: axis 0; each item corresponds to a DataFrame contained inside * **major_axis**: axis 1; the index (rows) of each of the DataFrames * **minor_axis**: axis 2; the columns of each of the DataFrames .. autosummary:: :toctree: generated/ Panel.values Panel.axes Panel.ndim Panel.size Panel.shape Panel.dtypes Panel.ftypes Panel.get_dtype_counts Panel.get_ftype_counts Conversion ~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel.astype Panel.copy Panel.isnull Panel.notnull Getting and setting ~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel.get_value Panel.set_value Indexing, iteration, slicing ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel.at Panel.iat Panel.loc Panel.iloc Panel.__iter__ Panel.iteritems Panel.pop Panel.xs Panel.major_xs Panel.minor_xs For more information on ``.at``, ``.iat``, ``.loc``, and ``.iloc``, see the :ref:`indexing documentation `. Binary operator functions ~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel.add Panel.sub Panel.mul Panel.div Panel.truediv Panel.floordiv Panel.mod Panel.pow Panel.radd Panel.rsub Panel.rmul Panel.rdiv Panel.rtruediv Panel.rfloordiv Panel.rmod Panel.rpow Panel.lt Panel.gt Panel.le Panel.ge Panel.ne Panel.eq Function application, GroupBy ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel.apply Panel.groupby .. _api.panel.stats: Computations / Descriptive Stats ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel.abs Panel.clip Panel.clip_lower Panel.clip_upper Panel.count Panel.cummax Panel.cummin Panel.cumprod Panel.cumsum Panel.max Panel.mean Panel.median Panel.min Panel.pct_change Panel.prod Panel.sem Panel.skew Panel.sum Panel.std Panel.var Reindexing / Selection / Label manipulation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel.add_prefix Panel.add_suffix Panel.drop Panel.equals Panel.filter Panel.first Panel.last Panel.reindex Panel.reindex_axis Panel.reindex_like Panel.rename Panel.sample Panel.select Panel.take Panel.truncate Missing data handling ~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel.dropna Panel.fillna Reshaping, sorting, transposing ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel.sort_index Panel.swaplevel Panel.transpose Panel.swapaxes Panel.conform Combining / joining / merging ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel.join Panel.update Time series-related ~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel.asfreq Panel.shift Panel.resample Panel.tz_convert Panel.tz_localize Serialization / IO / Conversion ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel.from_dict Panel.to_pickle Panel.to_excel Panel.to_hdf Panel.to_sparse Panel.to_frame Panel.to_xarray Panel.to_clipboard .. _api.panel4d: Panel4D ------- Constructor ~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel4D Serialization / IO / Conversion ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel4D.to_xarray Attributes and underlying data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ **Axes** * **labels**: axis 1; each label corresponds to a Panel contained inside * **items**: axis 2; each item corresponds to a DataFrame contained inside * **major_axis**: axis 3; the index (rows) of each of the DataFrames * **minor_axis**: axis 4; the columns of each of the DataFrames .. autosummary:: :toctree: generated/ Panel4D.values Panel4D.axes Panel4D.ndim Panel4D.size Panel4D.shape Panel4D.dtypes Panel4D.ftypes Panel4D.get_dtype_counts Panel4D.get_ftype_counts Conversion ~~~~~~~~~~ .. autosummary:: :toctree: generated/ Panel4D.astype Panel4D.copy Panel4D.isnull Panel4D.notnull .. _api.index: Index ----- **Many of these methods or variants thereof are available on the objects that contain an index (Series/Dataframe) and those should most likely be used before calling these methods directly.** .. autosummary:: :toctree: generated/ Index Attributes ~~~~~~~~~~ .. autosummary:: :toctree: generated/ Index.values Index.is_monotonic Index.is_monotonic_increasing Index.is_monotonic_decreasing Index.is_unique Index.has_duplicates Index.dtype Index.inferred_type Index.is_all_dates Index.shape Index.nbytes Index.ndim Index.size Index.strides Index.itemsize Index.base Index.T Index.memory_usage Modifying and Computations ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Index.all Index.any Index.argmin Index.argmax Index.copy Index.delete Index.drop Index.drop_duplicates Index.duplicated Index.equals Index.factorize Index.identical Index.insert Index.min Index.max Index.reindex Index.repeat Index.where Index.take Index.putmask Index.set_names Index.unique Index.nunique Index.value_counts Index.fillna Index.dropna Conversion ~~~~~~~~~~ .. autosummary:: :toctree: generated/ Index.astype Index.tolist Index.to_datetime Index.to_series Sorting ~~~~~~~ .. autosummary:: :toctree: generated/ Index.argsort Index.sort_values Time-specific operations ~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Index.shift Combining / joining / set operations ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Index.append Index.join Index.intersection Index.union Index.difference Index.symmetric_difference Selecting ~~~~~~~~~ .. autosummary:: :toctree: generated/ Index.get_indexer Index.get_indexer_non_unique Index.get_level_values Index.get_loc Index.get_value Index.isin Index.slice_indexer Index.slice_locs .. _api.categoricalindex: CategoricalIndex ---------------- .. autosummary:: :toctree: generated/ CategoricalIndex Categorical Components ~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ CategoricalIndex.codes CategoricalIndex.categories CategoricalIndex.ordered CategoricalIndex.rename_categories CategoricalIndex.reorder_categories CategoricalIndex.add_categories CategoricalIndex.remove_categories CategoricalIndex.remove_unused_categories CategoricalIndex.set_categories CategoricalIndex.as_ordered CategoricalIndex.as_unordered .. _api.multiindex: MultiIndex ---------- .. autosummary:: :toctree: generated/ MultiIndex MultiIndex Components ~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ MultiIndex.from_arrays MultiIndex.from_tuples MultiIndex.from_product MultiIndex.set_levels MultiIndex.set_labels MultiIndex.to_hierarchical MultiIndex.is_lexsorted MultiIndex.droplevel MultiIndex.swaplevel MultiIndex.reorder_levels .. _api.datetimeindex: DatetimeIndex ------------- .. autosummary:: :toctree: generated/ DatetimeIndex Time/Date Components ~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ DatetimeIndex.year DatetimeIndex.month DatetimeIndex.day DatetimeIndex.hour DatetimeIndex.minute DatetimeIndex.second DatetimeIndex.microsecond DatetimeIndex.nanosecond DatetimeIndex.date DatetimeIndex.time DatetimeIndex.dayofyear DatetimeIndex.weekofyear DatetimeIndex.week DatetimeIndex.dayofweek DatetimeIndex.weekday DatetimeIndex.weekday_name DatetimeIndex.quarter DatetimeIndex.tz DatetimeIndex.freq DatetimeIndex.freqstr DatetimeIndex.is_month_start DatetimeIndex.is_month_end DatetimeIndex.is_quarter_start DatetimeIndex.is_quarter_end DatetimeIndex.is_year_start DatetimeIndex.is_year_end DatetimeIndex.is_leap_year DatetimeIndex.inferred_freq Selecting ~~~~~~~~~ .. autosummary:: :toctree: generated/ DatetimeIndex.indexer_at_time DatetimeIndex.indexer_between_time Time-specific operations ~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ DatetimeIndex.normalize DatetimeIndex.strftime DatetimeIndex.snap DatetimeIndex.tz_convert DatetimeIndex.tz_localize DatetimeIndex.round DatetimeIndex.floor DatetimeIndex.ceil Conversion ~~~~~~~~~~ .. autosummary:: :toctree: generated/ DatetimeIndex.to_datetime DatetimeIndex.to_period DatetimeIndex.to_perioddelta DatetimeIndex.to_pydatetime DatetimeIndex.to_series TimedeltaIndex -------------- .. autosummary:: :toctree: generated/ TimedeltaIndex Components ~~~~~~~~~~ .. autosummary:: :toctree: generated/ TimedeltaIndex.days TimedeltaIndex.seconds TimedeltaIndex.microseconds TimedeltaIndex.nanoseconds TimedeltaIndex.components TimedeltaIndex.inferred_freq Conversion ~~~~~~~~~~ .. autosummary:: :toctree: generated/ TimedeltaIndex.to_pytimedelta TimedeltaIndex.to_series TimedeltaIndex.round TimedeltaIndex.floor TimedeltaIndex.ceil Window ------ .. currentmodule:: pandas.core.window Rolling objects are returned by ``.rolling`` calls: :func:`pandas.DataFrame.rolling`, :func:`pandas.Series.rolling`, etc. Expanding objects are returned by ``.expanding`` calls: :func:`pandas.DataFrame.expanding`, :func:`pandas.Series.expanding`, etc. EWM objects are returned by ``.ewm`` calls: :func:`pandas.DataFrame.ewm`, :func:`pandas.Series.ewm`, etc. Standard moving window functions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. currentmodule:: pandas.core.window .. autosummary:: :toctree: generated/ Rolling.count Rolling.sum Rolling.mean Rolling.median Rolling.var Rolling.std Rolling.min Rolling.max Rolling.corr Rolling.cov Rolling.skew Rolling.kurt Rolling.apply Rolling.quantile Window.mean Window.sum .. _api.functions_expanding: Standard expanding window functions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. currentmodule:: pandas.core.window .. autosummary:: :toctree: generated/ Expanding.count Expanding.sum Expanding.mean Expanding.median Expanding.var Expanding.std Expanding.min Expanding.max Expanding.corr Expanding.cov Expanding.skew Expanding.kurt Expanding.apply Expanding.quantile Exponentially-weighted moving window functions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. currentmodule:: pandas.core.window .. autosummary:: :toctree: generated/ EWM.mean EWM.std EWM.var EWM.corr EWM.cov GroupBy ------- .. currentmodule:: pandas.core.groupby GroupBy objects are returned by groupby calls: :func:`pandas.DataFrame.groupby`, :func:`pandas.Series.groupby`, etc. Indexing, iteration ~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ GroupBy.__iter__ GroupBy.groups GroupBy.indices GroupBy.get_group .. currentmodule:: pandas .. autosummary:: :toctree: generated/ Grouper .. currentmodule:: pandas.core.groupby Function application ~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ GroupBy.apply GroupBy.aggregate GroupBy.transform Computations / Descriptive Stats ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ GroupBy.count GroupBy.cumcount GroupBy.first GroupBy.head GroupBy.last GroupBy.max GroupBy.mean GroupBy.median GroupBy.min GroupBy.nth GroupBy.ohlc GroupBy.prod GroupBy.size GroupBy.sem GroupBy.std GroupBy.sum GroupBy.var GroupBy.tail The following methods are available in both ``SeriesGroupBy`` and ``DataFrameGroupBy`` objects, but may differ slightly, usually in that the ``DataFrameGroupBy`` version usually permits the specification of an axis argument, and often an argument indicating whether to restrict application to columns of a specific data type. .. autosummary:: :toctree: generated/ DataFrameGroupBy.agg DataFrameGroupBy.all DataFrameGroupBy.any DataFrameGroupBy.bfill DataFrameGroupBy.corr DataFrameGroupBy.count DataFrameGroupBy.cov DataFrameGroupBy.cummax DataFrameGroupBy.cummin DataFrameGroupBy.cumprod DataFrameGroupBy.cumsum DataFrameGroupBy.describe DataFrameGroupBy.diff DataFrameGroupBy.ffill DataFrameGroupBy.fillna DataFrameGroupBy.hist DataFrameGroupBy.idxmax DataFrameGroupBy.idxmin DataFrameGroupBy.mad DataFrameGroupBy.pct_change DataFrameGroupBy.plot DataFrameGroupBy.quantile DataFrameGroupBy.rank DataFrameGroupBy.resample DataFrameGroupBy.shift DataFrameGroupBy.size DataFrameGroupBy.skew DataFrameGroupBy.take DataFrameGroupBy.tshift The following methods are available only for ``SeriesGroupBy`` objects. .. autosummary:: :toctree: generated/ SeriesGroupBy.nlargest SeriesGroupBy.nsmallest SeriesGroupBy.nunique SeriesGroupBy.unique SeriesGroupBy.value_counts The following methods are available only for ``DataFrameGroupBy`` objects. .. autosummary:: :toctree: generated/ DataFrameGroupBy.corrwith DataFrameGroupBy.boxplot Resampling ---------- .. currentmodule:: pandas.tseries.resample Resampler objects are returned by resample calls: :func:`pandas.DataFrame.resample`, :func:`pandas.Series.resample`. Indexing, iteration ~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Resampler.__iter__ Resampler.groups Resampler.indices Resampler.get_group Function application ~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Resampler.apply Resampler.aggregate Resampler.transform Upsampling ~~~~~~~~~~ .. autosummary:: :toctree: generated/ Resampler.ffill Resampler.backfill Resampler.bfill Resampler.pad Resampler.fillna Resampler.asfreq Resampler.interpolate Computations / Descriptive Stats ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Resampler.count Resampler.nunique Resampler.first Resampler.last Resampler.max Resampler.mean Resampler.median Resampler.min Resampler.ohlc Resampler.prod Resampler.size Resampler.sem Resampler.std Resampler.sum Resampler.var Style ----- .. currentmodule:: pandas.formats.style ``Styler`` objects are returned by :attr:`pandas.DataFrame.style`. Constructor ~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Styler Style Application ~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Styler.apply Styler.applymap Styler.format Styler.set_precision Styler.set_table_styles Styler.set_caption Styler.set_properties Styler.set_uuid Styler.clear Builtin Styles ~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Styler.highlight_max Styler.highlight_min Styler.highlight_null Styler.background_gradient Styler.bar Style Export and Import ~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ Styler.render Styler.export Styler.use .. currentmodule:: pandas General utility functions ------------------------- Working with options ~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated/ describe_option reset_option get_option set_option option_context