> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pysquirrels.com/llms.txt
> Use this file to discover all available pages before exploring further.

# DashboardArgs

> Arguments for dashboard generation functions

`DashboardArgs` is the class type of the `sqrl` argument for dashboard functions (i.e. the main function in dashboard files in the `dashboards/` folder), which runs when an API request is made to the dashboard.

The class can be imported from the `squirrels.arguments` or `squirrels` module.

## Properties

<ResponseField name="project_path" type="str">
  Path to the Squirrels project directory.
</ResponseField>

<ResponseField name="proj_vars" type="dict[str, Any]">
  A copy of project variables as a dictionary.
</ResponseField>

<ResponseField name="env_vars" type="dict[str, str]">
  A copy of environment variables as a dictionary.
</ResponseField>

## Methods

### dataset()

Async method to get a dataset as a polars DataFrame given the dataset name.

Unlike the `dataset_result` method of [SquirrelsProject] which requires parameter selections to be explicitly provided through code, this method automatically borrows selections applied to the dashboard.

```python theme={null}
async def dataset(
    self, name: str, *, fixed_parameters: dict[str, Any] = {}
) -> polars.DataFrame:
```

<Expandable title="arguments" defaultOpen>
  <ResponseField name="name" type="string" required>
    The dataset name.
  </ResponseField>

  <ResponseField name="fixed_parameters" type="dict[str, Any]" default={{}}>
    Parameters to set for this dataset.
  </ResponseField>
</Expandable>

<ResponseField name="returns" type="polars.DataFrame">A polars DataFrame of the dataset result.</ResponseField>

[SquirrelsProject]: /references/python/squirrelsproject