Skip to content
This repository has been archived by the owner on Feb 2, 2024. It is now read-only.

new api ref sections. part 1 #461

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions docs/source/_templates/_api_ref.pandas.general_functions_templ.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
.. _api_ref.pandas.general_functions:
.. include:: ./../ext_links.txt

General Functions
=================
.. currentmodule:: pandas

This section covers general Pandas operations

Data manipulations
~~~~~~~~~~~~~~~~~~

.. sdc_toctree
melt
pivot
pivot_table
crosstab
cut
qcut
merge
merge_ordered
merge_asof
concat
get_dummies
factorize
unique
wide_to_long

Top-Level Missing Data
~~~~~~~~~~~~~~~~~~~~~~

.. sdc_toctree
isna
isnull
notna
notnull

Top-Level Conversions
~~~~~~~~~~~~~~~~~~~~~

.. sdc_toctree
to_numeric

Top-Level Working With Dates & Time
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. sdc_toctree
to_datetime
to_timedelta
date_range
bdate_range
period_range
timedelta_range
infer_freq

Top-Level Dealing With Intervals
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. sdc_toctree
interval_range

Top-Level Evaluation
~~~~~~~~~~~~~~~~~~~~

.. sdc_toctree
eval

Hashing
~~~~~~~

.. sdc_toctree
util.hash_array
util.hash_pandas_object
125 changes: 125 additions & 0 deletions docs/source/_templates/_api_ref.pandas.groupby_templ.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
.. _api_ref.pandas.groupby:
.. include:: ./../ext_links.txt

GroupBy
=======
.. currentmodule:: pandas.core.groupby

This section covers operations for grouping data in series and dataframes.

GroupBy objects are returned by groupby calls: :func:`pandas.DataFrame.groupby`, :func:`pandas.Series.groupby`, etc.

Indexing and Iteration
----------------------

.. sdc_toctree
GroupBy.__iter__
GroupBy.groups
GroupBy.indices
GroupBy.get_group

.. currentmodule:: pandas

.. sdc_toctree
Grouper

.. currentmodule:: pandas.core.groupby

User-Defined Functions
----------------------

.. sdc_toctree
GroupBy.apply
GroupBy.agg
GroupBy.aggregate
GroupBy.transform
GroupBy.pipe

Computations, Descriptive Statistics
------------------------------------

.. sdc_toctree
GroupBy.all
GroupBy.any
GroupBy.bfill
GroupBy.count
GroupBy.cumcount
GroupBy.cummax
GroupBy.cummin
GroupBy.cumprod
GroupBy.cumsum
GroupBy.ffill
GroupBy.first
GroupBy.head
GroupBy.last
GroupBy.max
GroupBy.mean
GroupBy.median
GroupBy.min
GroupBy.ngroup
GroupBy.nth
GroupBy.ohlc
GroupBy.prod
GroupBy.rank
GroupBy.pct_change
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.

.. sdc_toctree
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.filter
DataFrameGroupBy.hist
DataFrameGroupBy.idxmax
DataFrameGroupBy.idxmin
DataFrameGroupBy.mad
DataFrameGroupBy.nunique
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.

.. sdc_toctree
SeriesGroupBy.nlargest
SeriesGroupBy.nsmallest
SeriesGroupBy.nunique
SeriesGroupBy.unique
SeriesGroupBy.value_counts
SeriesGroupBy.is_monotonic_increasing
SeriesGroupBy.is_monotonic_decreasing

The following methods are available only for ``DataFrameGroupBy`` objects.

.. sdc_toctree
DataFrameGroupBy.corrwith
DataFrameGroupBy.boxplot
124 changes: 124 additions & 0 deletions docs/source/_templates/_api_ref.pandas.io_templ.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
.. _api_ref.pandas.io:
.. include:: ./../ext_links.txt

Input-Output
============
.. currentmodule:: pandas

This section include `Pandas*`_ functions for input data of a specific format into memory and for output in-memory
data to external storage format.


Pickling
~~~~~~~~

.. sdc_toctree
read_pickle

Flat Files
~~~~~~~~~~

.. sdc_toctree
read_table
read_csv
read_fwf

Clipboard
~~~~~~~~~

.. sdc_toctree
read_clipboard

Excel
~~~~~

.. sdc_toctree
read_excel
ExcelFile.parse
ExcelWriter

JSON
~~~~

.. sdc_toctree
read_json

.. currentmodule:: pandas.io.json

.. sdc_toctree
json_normalize
build_table_schema

.. currentmodule:: pandas

HTML
~~~~

.. sdc_toctree
read_html

HDFStore: PyTables (HDF5)
~~~~~~~~~~~~~~~~~~~~~~~~~

.. sdc_toctree
read_hdf
HDFStore.put
HDFStore.append
HDFStore.get
HDFStore.select
HDFStore.info
HDFStore.keys
HDFStore.groups
HDFStore.walk

Feather
~~~~~~~

.. sdc_toctree
read_feather

Parquet
~~~~~~~

.. sdc_toctree
read_parquet

SAS
~~~

.. sdc_toctree
read_sas

SPSS
~~~~

.. sdc_toctree
read_spss

SQL
~~~

.. sdc_toctree
read_sql_table
read_sql_query
read_sql

Google BigQuery
~~~~~~~~~~~~~~~

.. sdc_toctree
read_gbq

STATA
~~~~~

.. sdc_toctree
read_stata

.. currentmodule:: pandas.io.stata

.. sdc_toctree
StataReader.data_label
StataReader.value_labels
StataReader.variable_labels
StataWriter.write_file
Loading