# R Environment Index

The index is required for the R help integrated in StatET.

## Indexing of R Environments

An R environment is indexed within the R console in StatET. The R environment used to start the R console is also used for all other operations, which are associated with R environments, including the indexing operations. Therefore, to index an environment, the user has to start an R console (local or remote) for this R environment.

### Preferences / Automatic Modes

The preference page of the R environments at R > R Environments offers in the lower part an option to configure globally the automatic indexing of R environments.

The user can select between three modes:

- Check and Update Automatically: StatET automatically checks if new packages are installed or indexed packages are updated. When it detects changes, the index for the concerned packages is updated. The user is notified about the start and the success of the update.
- Check Automatically and Ask: Like the previous mode, but if changes are detected, StatET asks the user before it starts the update, if the indexing operations should be performed or if the user wants to postpone the update.
- Manual: StatET does never check if the index is created or up-to-date. The user must use the commands below to manage the R environment indexes.

### Manual Operations / Commands

It is possible to manually update the R environment index of the current R console on demand.

| Name | Description | Availability
--- | --- | --- | ---
The commands are accessible in the submenu R environment in the menu of the Console view.
| Reset R environment index | This action discards the current R environment index if available, and newly indexes it completely. | View Menu Global command
| Update R environment index | If the user triggers this action, StatET indexes only the changes of the R environment, like in the automatic mode described above. | View Menu Global command `Ctrl+R, I`