Skip to content

Commit

Permalink
[WIP]: API doc
Browse files Browse the repository at this point in the history
  • Loading branch information
TomAugspurger committed Nov 9, 2017
1 parent 500ab71 commit 257fc8a
Showing 1 changed file with 56 additions and 1 deletion.
57 changes: 56 additions & 1 deletion doc/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -701,6 +701,7 @@ adding ordering information or special categories is need at creation time of th
Categorical.categories
Categorical.ordered
Categorical.codes
Categorical.dtype
Categorical.from_codes

``np.asarray(categorical)`` works by implementing the array interface. Be aware, that this converts
Expand Down Expand Up @@ -801,11 +802,14 @@ Attributes and underlying data
DataFrame.get_ftype_counts
DataFrame.select_dtypes
DataFrame.values
DataFrame.get_values
DataFrame.axes
DataFrame.ndim
DataFrame.size
DataFrame.shape
DataFrame.memory_usage
DataFrame.empty
DataFrame.is_copy

Conversion
~~~~~~~~~~
Expand All @@ -818,6 +822,7 @@ Conversion
DataFrame.copy
DataFrame.isna
DataFrame.notna
DataFrame.bool

Indexing, iteration
~~~~~~~~~~~~~~~~~~~
Expand All @@ -830,14 +835,18 @@ Indexing, iteration
DataFrame.loc
DataFrame.iloc
DataFrame.insert
DataFrame.insert
DataFrame.__iter__
DataFrame.items
DataFrame.keys
DataFrame.iteritems
DataFrame.iterrows
DataFrame.itertuples
DataFrame.lookup
DataFrame.pop
DataFrame.tail
DataFrame.xs
DataFrame.get
DataFrame.isin
DataFrame.where
DataFrame.mask
Expand All @@ -854,12 +863,16 @@ Binary operator functions

DataFrame.add
DataFrame.sub
DataFrame.subtract
DataFrame.mul
DataFrame.multiply
DataFrame.div
DataFrame.divide
DataFrame.truediv
DataFrame.floordiv
DataFrame.mod
DataFrame.pow
DataFrame.dot
DataFrame.radd
DataFrame.rsub
DataFrame.rmul
Expand All @@ -884,6 +897,8 @@ Function application, GroupBy & Window

DataFrame.apply
DataFrame.applymap
DataFrame.pipe
DataFrame.agg
DataFrame.aggregate
DataFrame.transform
DataFrame.groupby
Expand All @@ -904,6 +919,7 @@ Computations / Descriptive Stats
DataFrame.clip
DataFrame.clip_lower
DataFrame.clip_upper
DataFrame.compound
DataFrame.corr
DataFrame.corrwith
DataFrame.count
Expand All @@ -916,6 +932,7 @@ Computations / Descriptive Stats
DataFrame.diff
DataFrame.eval
DataFrame.kurt
DataFrame.kurtosis
DataFrame.mad
DataFrame.max
DataFrame.mean
Expand All @@ -924,6 +941,7 @@ Computations / Descriptive Stats
DataFrame.mode
DataFrame.pct_change
DataFrame.prod
DataFrame.product
DataFrame.quantile
DataFrame.rank
DataFrame.round
Expand All @@ -932,6 +950,7 @@ Computations / Descriptive Stats
DataFrame.sum
DataFrame.std
DataFrame.var
DataFrame.nunique

Reindexing / Selection / Label manipulation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -941,6 +960,8 @@ Reindexing / Selection / Label manipulation
DataFrame.add_prefix
DataFrame.add_suffix
DataFrame.align
DataFrame.at_time
DataFrame.between_time
DataFrame.drop
DataFrame.drop_duplicates
DataFrame.duplicated
Expand All @@ -959,6 +980,7 @@ Reindexing / Selection / Label manipulation
DataFrame.reset_index
DataFrame.sample
DataFrame.select
DataFrame.set_axis
DataFrame.set_index
DataFrame.tail
DataFrame.take
Expand All @@ -974,13 +996,17 @@ Missing data handling
DataFrame.dropna
DataFrame.fillna
DataFrame.replace
DataFrame.interpolate
DataFrame.isnull
DataFrame.notnull

Reshaping, sorting, transposing
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/

DataFrame.pivot
DataFrame.pivot_table
DataFrame.reorder_levels
DataFrame.sort_values
DataFrame.sort_index
Expand All @@ -989,10 +1015,12 @@ Reshaping, sorting, transposing
DataFrame.swaplevel
DataFrame.stack
DataFrame.unstack
DataFrame.swapaxes
DataFrame.melt
DataFrame.T
DataFrame.squeeze
DataFrame.to_panel
DataFrame.to_xarray
DataFrame.T
DataFrame.transpose

Combining / joining / merging
Expand All @@ -1014,6 +1042,8 @@ Time series-related
DataFrame.asfreq
DataFrame.asof
DataFrame.shift
DataFrame.slice_shift
DataFrame.tshift
DataFrame.first_valid_index
DataFrame.last_valid_index
DataFrame.resample
Expand Down Expand Up @@ -1068,6 +1098,7 @@ Serialization / IO / Conversion
DataFrame.from_items
DataFrame.from_records
DataFrame.info
DataFrame.to_parquet
DataFrame.to_pickle
DataFrame.to_csv
DataFrame.to_hdf
Expand All @@ -1086,6 +1117,7 @@ Serialization / IO / Conversion
DataFrame.to_dense
DataFrame.to_string
DataFrame.to_clipboard
DataFrame.style

Sparse
~~~~~~
Expand Down Expand Up @@ -2313,3 +2345,26 @@ Scalar introspection
api.types.is_re
api.types.is_re_compilable
api.types.is_scalar


.. This is to prevent warnings in the doc build. We don't want to encourage
.. these methods.
.. toctree::
:hidden:

generated/pandas.DataFrame.as_blocks
generated/pandas.DataFrame.ffill
generated/pandas.DataFrame.bfill
generated/pandas.DataFrame.blocks
generated/pandas.DataFrame.sortlevel
generated/pandas.DataFrame.consolidate
generated/pandas.DataFrame.set_value
generated/pandas.DataFrame.get_value

generated/pandas.Series.as_blocks
generated/pandas.Series.ffill
generated/pandas.Series.bfill
generated/pandas.Series.set_value
generated/pandas.Series.get_value
generated/pandas.Series.blocks

0 comments on commit 257fc8a

Please sign in to comment.