Skip to content

api.rst

Latest commit

 

History

History
857 lines (645 loc) · 12 KB

api.rst

File metadata and controls

857 lines (645 loc) · 12 KB
Raw

API Reference

.. currentmodule:: larray

Axis

.. autosummary::
   :toctree: _generated/

   Axis

Exploring

Axis.name Name of the axis. None in the case of an anonymous axis.
:attr:`Axis.labels` Labels of the axis.
:attr:`Axis.labels_summary` Short representation of the labels.
:attr:`Axis.dtype` Data type for the axis labels.

Copying

.. autosummary::
   :toctree: _generated/

   Axis.copy

Searching

.. autosummary::
   :toctree: _generated/

   Axis.index
   Axis.containing
   Axis.startingwith
   Axis.endingwith
   Axis.matching

Modifying/Selecting

.. autosummary::
   :toctree: _generated/

   Axis.__getitem__
   Axis.i
   Axis.by
   Axis.rename
   Axis.subaxis
   Axis.extend
   Axis.insert
   Axis.replace
   Axis.apply
   Axis.union
   Axis.intersection
   Axis.difference
   Axis.align
   Axis.split
   Axis.ignore_labels

Testing

.. autosummary::
   :toctree: _generated/

   Axis.iscompatible
   Axis.equals

Save

.. autosummary::
   :toctree: _generated/

   Axis.to_hdf

Group

IGroup

.. autosummary::
   :toctree: _generated/

   IGroup


.. autosummary::
   :toctree: _generated/

   IGroup.named
   IGroup.with_axis
   IGroup.by
   IGroup.equals
   IGroup.translate
   IGroup.union
   IGroup.intersection
   IGroup.difference
   IGroup.containing
   IGroup.startingwith
   IGroup.endingwith
   IGroup.matching
   IGroup.to_hdf

LGroup

.. autosummary::
   :toctree: _generated/

   LGroup


.. autosummary::
   :toctree: _generated/

   LGroup.named
   LGroup.with_axis
   LGroup.by
   LGroup.equals
   LGroup.translate
   LGroup.union
   LGroup.intersection
   LGroup.difference
   LGroup.containing
   LGroup.startingwith
   LGroup.endingwith
   LGroup.matching
   LGroup.to_hdf

LSet

.. autosummary::
   :toctree: _generated/

   LSet

AxisCollection

.. autosummary::
   :toctree: _generated/

   AxisCollection


.. autosummary::
   :toctree: _generated/

   AxisCollection.names
   AxisCollection.display_names
   AxisCollection.labels
   AxisCollection.shape
   AxisCollection.size
   AxisCollection.info
   AxisCollection.copy

Searching

.. autosummary::
   :toctree: _generated/

   AxisCollection.keys
   AxisCollection.index
   AxisCollection.axis_id
   AxisCollection.ids
   AxisCollection.iter_labels

Modifying/Selecting

.. autosummary::
   :toctree: _generated/

   AxisCollection.get
   AxisCollection.get_by_pos
   AxisCollection.get_all
   AxisCollection.pop
   AxisCollection.append
   AxisCollection.extend
   AxisCollection.insert
   AxisCollection.rename
   AxisCollection.replace
   AxisCollection.set_labels
   AxisCollection.without
   AxisCollection.combine_axes
   AxisCollection.split_axes
   AxisCollection.align

Testing

.. autosummary::
   :toctree: _generated/

   AxisCollection.isaxis
   AxisCollection.check_compatible

LArray

  • :ref:`la_overview`
  • :ref:`la_creation_func`
  • :ref:`la_copying`
  • :ref:`la_inspecting`
  • :ref:`la_selecting`
  • :ref:`la_axes_labels`
  • :ref:`la_agg`
  • :ref:`la_sorting`
  • :ref:`la_reshaping`
  • :ref:`la_testing`
  • :ref:`la_iter`
  • :ref:`la_op`
  • :ref:`la_misc`
  • :ref:`la_to_pandas`
  • :ref:`la_plotting`

Overview

.. autosummary::
   :toctree: _generated/

   LArray

Array Creation Functions

.. autosummary::
   :toctree: _generated/

   sequence
   ndtest
   zeros
   zeros_like
   ones
   ones_like
   empty
   empty_like
   full
   full_like

Copying

.. autosummary::
   :toctree: _generated/

   LArray.copy
   LArray.astype

Inspecting

LArray.data Data of the array (Numpy ndarray)
LArray.axes Axes of the array (AxisCollection)
LArray.title Title of the array (str) 
.. autosummary::
   :toctree: _generated/

   LArray.info
   LArray.shape
   LArray.ndim
   LArray.dtype
   LArray.size
   LArray.nbytes
   LArray.memory_used

Modifying/Selecting

.. autosummary::
   :toctree: _generated/

   LArray.i
   LArray.points
   LArray.ipoints
   LArray.iflat
   LArray.set
   LArray.drop
   LArray.ignore_labels
   LArray.filter
   LArray.apply
   LArray.apply_map

Changing Axes or Labels

.. autosummary::
   :toctree: _generated/

   LArray.set_axes
   LArray.rename
   LArray.set_labels
   LArray.combine_axes
   LArray.split_axes
   LArray.reverse

Aggregation Functions

.. autosummary::
   :toctree: _generated/

   LArray.sum
   LArray.sum_by
   LArray.prod
   LArray.prod_by
   LArray.cumsum
   LArray.cumprod
   LArray.mean
   LArray.mean_by
   LArray.median
   LArray.median_by
   LArray.var
   LArray.var_by
   LArray.std
   LArray.std_by
   LArray.percentile
   LArray.percentile_by
   LArray.ptp
   LArray.with_total
   LArray.percent
   LArray.ratio
   LArray.rationot0
   LArray.growth_rate
   LArray.describe
   LArray.describe_by

Sorting

.. autosummary::
   :toctree: _generated/

   LArray.sort_axes
   LArray.sort_values
   LArray.labelsofsorted
   LArray.indicesofsorted

Reshaping/Extending/Reordering

.. autosummary::
   :toctree: _generated/

   LArray.reshape
   LArray.reshape_like
   LArray.compact
   LArray.reindex
   LArray.transpose
   LArray.expand
   LArray.prepend
   LArray.append
   LArray.extend
   LArray.insert
   LArray.broadcast_with
   LArray.align

Testing/Searching

.. autosummary::
   :toctree: _generated/

   LArray.equals
   LArray.eq
   LArray.isin
   LArray.nonzero
   LArray.all
   LArray.all_by
   LArray.any
   LArray.any_by
   LArray.min
   LArray.min_by
   LArray.max
   LArray.max_by
   LArray.labelofmin
   LArray.indexofmin
   LArray.labelofmax
   LArray.indexofmax

Iterating

.. autosummary::
   :toctree: _generated/

   LArray.keys
   LArray.values
   LArray.items

Operators

:py:meth:`@ <LArray.__matmul__>` Matrix multiplication

Miscellaneous

.. autosummary::
   :toctree: _generated/

   LArray.divnot0
   LArray.clip
   LArray.shift
   LArray.roll
   LArray.diff
   LArray.unique
   LArray.to_clipboard

Converting to Pandas objects

.. autosummary::
   :toctree: _generated/

   LArray.to_series
   LArray.to_frame

Plotting

.. autosummary::
   :toctree: _generated/

   LArray.plot

Utility Functions

  • :ref:`ufuncs_misc`
  • :ref:`ufuncs_rounding`
  • :ref:`ufuncs_exp_log`
  • :ref:`ufuncs_trigo`
  • :ref:`ufuncs_hyper`
  • :ref:`ufuncs_complex`
  • :ref:`ufuncs_floating`

Miscellaneous

.. autosummary::
   :toctree: _generated/

   where
   maximum
   minimum
   inverse
   interp
   convolve
   absolute
   fabs
   isnan
   isinf
   nan_to_num
   sqrt
   i0
   sinc

Rounding

.. autosummary::
   :toctree: _generated/

   round
   floor
   ceil
   trunc
   rint
   fix

Exponents And Logarithms

.. autosummary::
   :toctree: _generated/

    exp
    expm1
    exp2
    log
    log10
    log2
    log1p
    logaddexp
    logaddexp2

Trigonometric functions

.. autosummary::
   :toctree: _generated/

    sin
    cos
    tan
    arcsin
    arccos
    arctan
    hypot
    arctan2
    degrees
    radians
    unwrap

Hyperbolic functions

.. autosummary::
   :toctree: _generated/

   sinh
   cosh
   tanh
   arcsinh
   arccosh
   arctanh

Complex Numbers

.. autosummary::
   :toctree: _generated/

   angle
   real
   imag
   conj

Floating Point Routines

.. autosummary::
   :toctree: _generated/

   signbit
   copysign
   frexp
   ldexp

Metadata

.. autosummary::
   :toctree: _generated/

   Metadata

Input/Output

Read

.. autosummary::
   :toctree: _generated/

   read_csv
   read_tsv
   read_excel
   read_hdf
   read_eurostat
   read_sas
   read_stata

Write

.. autosummary::
   :toctree: _generated/

   LArray.to_csv
   LArray.to_excel
   LArray.to_hdf
   LArray.to_stata
   LArray.dump

Excel

.. autosummary::
   :toctree: _generated/

   open_excel


.. autosummary::
   :toctree: _generated/

   Workbook
   Workbook.sheet_names
   Workbook.save
   Workbook.close
   Workbook.app

ExcelReport

.. autosummary::
   :toctree: _generated/

   ExcelReport
   ExcelReport.template_dir
   ExcelReport.template
   ExcelReport.set_item_default_size
   ExcelReport.graphs_per_row
   ExcelReport.new_sheet
   ExcelReport.sheet_names
   ExcelReport.to_excel

ReportSheet

.. autosummary::
   :toctree: _generated/

   ReportSheet
   ReportSheet.template_dir
   ReportSheet.template
   ReportSheet.set_item_default_size
   ReportSheet.graphs_per_row
   ReportSheet.add_title
   ReportSheet.add_graph
   ReportSheet.add_graphs
   ReportSheet.newline

Miscellaneous

.. autosummary::
   :toctree: _generated/

   aslarray
   from_frame
   from_series
   get_example_filepath
   set_options
   get_options
   labels_array
   union
   stack
   identity
   diag
   eye
   ipfp
   wrap_elementwise_array_func
   zip_array_values
   zip_array_items

Session

.. autosummary::
   :toctree: _generated/

   Session
   arrays
   local_arrays
   global_arrays
   load_example_data

Exploring

.. autosummary::
   :toctree: _generated/

   Session.names
   Session.keys
   Session.values
   Session.items
   Session.summary

Copying

.. autosummary::
   :toctree: _generated/

   Session.copy

Testing

.. autosummary::
   :toctree: _generated/

   Session.element_equals
   Session.equals

Selecting

.. autosummary::
   :toctree: _generated/

   Session.get

Modifying

.. autosummary::
   :toctree: _generated/

   Session.add
   Session.update
   Session.get
   Session.apply
   Session.transpose

Filtering/Cleaning

.. autosummary::
   :toctree: _generated/

   Session.filter
   Session.compact

Load/Save

.. autosummary::
   :toctree: _generated/

   Session.load
   Session.save
   Session.to_csv
   Session.to_excel
   Session.to_hdf
   Session.to_pickle

Editor

.. autosummary::
   :toctree: _generated/

   view
   edit
   compare
   run_editor_on_exception

Random

.. autosummary::
   :toctree: _generated/

   random.randint
   random.normal
   random.uniform
   random.permutation
   random.choice

Constants

.. currentmodule:: larray.core.constants

.. autosummary::
   :nosignatures:
   :toctree: _generated/

   nan
   inf
   pi
   e
   euler_gamma