larch.Dataset.query_cases

larch.Dataset.query_cases

Dataset.query_cases(query, parser='pandas', engine=None)[source]

Return a new dataset with each array indexed along the CASEID dimension.

The indexers are given as strings containing Python expressions to be evaluated against the data variables in the dataset.

Parameters
  • query (str) – Python expressions to be evaluated against the data variables in the dataset. The expressions will be evaluated using the pandas eval() function, and can contain any valid Python expressions but cannot contain any Python statements.

  • parser ({"pandas", "python"}, default: "pandas") – The parser to use to construct the syntax tree from the expression. The default of ‘pandas’ parses code slightly different than standard Python. Alternatively, you can parse an expression using the ‘python’ parser to retain strict Python semantics.

  • engine ({"python", "numexpr", None}, default: None) –

    The engine used to evaluate the expression. Supported engines are:

    • None: tries to use numexpr, falls back to python

    • ”numexpr”: evaluates expressions using numexpr

    • ”python”: performs operations as if you had eval’d in top level python

Returns

obj (Dataset) – A new Dataset with the same contents as this dataset, except each array is indexed by the results of the query on the CASEID dimension.

See also

Dataset.isel, pandas.eval