argopy.stores.argo_index_pa.indexstore_pyarrow.to_dataframe

argopy.stores.argo_index_pa.indexstore_pyarrow.to_dataframe#

indexstore_pyarrow.to_dataframe(nrows=None, index=False, completed=True)#

Return index or search results as pandas.DataFrame

If search not triggered, fall back on full index by default. Using index=True force to return the full index.

Parameters:

  • nrows ({int, None}, default: None) – Will return only the first nrows of search results. None returns all.

  • index (bool, default: False) – Force to return the index, even if a search was performed with this store instance.

  • completed (bool, default: True) – Complete the raw index columns with: Platform Number (WMO), Cycle Number, Institution and Profiler details This is adding an extra computation, so if you care about performances, you may set this to False.

Return type:

pandas.DataFrame

Contents