openseries.OpenFrame
====================

.. currentmodule:: openseries

.. autoclass:: OpenFrame

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~OpenFrame.__init__
      ~OpenFrame.add_timeseries
      ~OpenFrame.align_index_to_local_cdays
      ~OpenFrame.all_properties
      ~OpenFrame.arithmetic_ret_func
      ~OpenFrame.beta
      ~OpenFrame.calc_range
      ~OpenFrame.capture_ratio_func
      ~OpenFrame.construct
      ~OpenFrame.copy
      ~OpenFrame.cvar_down_func
      ~OpenFrame.delete_timeseries
      ~OpenFrame.dict
      ~OpenFrame.ewma_risk
      ~OpenFrame.from_deepcopy
      ~OpenFrame.from_orm
      ~OpenFrame.geo_ret_func
      ~OpenFrame.info_ratio_func
      ~OpenFrame.jensen_alpha
      ~OpenFrame.json
      ~OpenFrame.kurtosis_func
      ~OpenFrame.lower_partial_moment_func
      ~OpenFrame.make_portfolio
      ~OpenFrame.max_drawdown_func
      ~OpenFrame.merge_series
      ~OpenFrame.model_construct
      ~OpenFrame.model_copy
      ~OpenFrame.model_dump
      ~OpenFrame.model_dump_json
      ~OpenFrame.model_json_schema
      ~OpenFrame.model_parametrized_name
      ~OpenFrame.model_post_init
      ~OpenFrame.model_rebuild
      ~OpenFrame.model_validate
      ~OpenFrame.model_validate_json
      ~OpenFrame.model_validate_strings
      ~OpenFrame.multi_factor_linear_regression
      ~OpenFrame.omega_ratio_func
      ~OpenFrame.ord_least_squares_fit
      ~OpenFrame.outliers
      ~OpenFrame.parse_file
      ~OpenFrame.parse_obj
      ~OpenFrame.parse_raw
      ~OpenFrame.plot_bars
      ~OpenFrame.plot_histogram
      ~OpenFrame.plot_series
      ~OpenFrame.positive_share_func
      ~OpenFrame.rebalanced_portfolio
      ~OpenFrame.relative
      ~OpenFrame.resample
      ~OpenFrame.resample_to_business_period_ends
      ~OpenFrame.ret_vol_ratio_func
      ~OpenFrame.return_nan_handle
      ~OpenFrame.rolling_beta
      ~OpenFrame.rolling_corr
      ~OpenFrame.rolling_cvar_down
      ~OpenFrame.rolling_info_ratio
      ~OpenFrame.rolling_return
      ~OpenFrame.rolling_var_down
      ~OpenFrame.rolling_vol
      ~OpenFrame.schema
      ~OpenFrame.schema_json
      ~OpenFrame.skew_func
      ~OpenFrame.sortino_ratio_func
      ~OpenFrame.target_weight_from_var
      ~OpenFrame.to_cumret
      ~OpenFrame.to_drawdown_series
      ~OpenFrame.to_json
      ~OpenFrame.to_xlsx
      ~OpenFrame.tracking_error_func
      ~OpenFrame.trunc_frame
      ~OpenFrame.update_forward_refs
      ~OpenFrame.validate
      ~OpenFrame.value_nan_handle
      ~OpenFrame.value_ret_calendar_period
      ~OpenFrame.value_ret_func
      ~OpenFrame.value_to_diff
      ~OpenFrame.value_to_log
      ~OpenFrame.value_to_ret
      ~OpenFrame.var_down_func
      ~OpenFrame.vol_from_var_func
      ~OpenFrame.vol_func
      ~OpenFrame.worst_func
      ~OpenFrame.z_score_func
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~OpenFrame.arithmetic_ret
      ~OpenFrame.columns_lvl_one
      ~OpenFrame.columns_lvl_zero
      ~OpenFrame.correl_matrix
      ~OpenFrame.cvar_down
      ~OpenFrame.downside_deviation
      ~OpenFrame.first_idx
      ~OpenFrame.first_indices
      ~OpenFrame.geo_ret
      ~OpenFrame.item_count
      ~OpenFrame.kappa3_ratio
      ~OpenFrame.kurtosis
      ~OpenFrame.last_idx
      ~OpenFrame.last_indices
      ~OpenFrame.length
      ~OpenFrame.lengths_of_items
      ~OpenFrame.max_drawdown
      ~OpenFrame.max_drawdown_cal_year
      ~OpenFrame.max_drawdown_date
      ~OpenFrame.model_computed_fields
      ~OpenFrame.model_config
      ~OpenFrame.model_extra
      ~OpenFrame.model_fields
      ~OpenFrame.model_fields_set
      ~OpenFrame.omega_ratio
      ~OpenFrame.periods_in_a_year
      ~OpenFrame.positive_share
      ~OpenFrame.ret_vol_ratio
      ~OpenFrame.skew
      ~OpenFrame.sortino_ratio
      ~OpenFrame.span_of_days
      ~OpenFrame.span_of_days_all
      ~OpenFrame.value_ret
      ~OpenFrame.var_down
      ~OpenFrame.vol
      ~OpenFrame.vol_from_var
      ~OpenFrame.worst
      ~OpenFrame.worst_month
      ~OpenFrame.yearfrac
      ~OpenFrame.z_score
      ~OpenFrame.constituents
      ~OpenFrame.tsdf
      ~OpenFrame.weights