<commit_before>---
layout: default
title: "Dashboard Overview"
search_title: "IRIDA Dashboard Overview"
description: "An overview of the features present on the IRIDA dashboard."
---

IRIDA Dashboard Overview
========================
{:.no_toc}

The IRIDA dashboard is the main location for accessing all of the data management and pipeline execution functionality built into IRIDA. This document describes the general features of the IRIDA dashboard.

* this comment becomes the TOC
{:toc}

Main Dashboard
--------------

The main IRIDA dashboard has several different areas:

* The [main menu](#main-menu), for accessing and managing data and pipelines,
* The [cart](#cart), for data selections,
* The [user settings](#user-settings) menu,
* The [logout](#logout) button,
* The [recent activities](#recent-activities) section, and
* The [updates](#updates-announcements) section.

![The main IRIDA dashboard.](images/dashboard.png)

Main Menu
---------

The main menu area is at the top, left-hand side of the IRIDA dashboard:

![The main menu in the dashboard.](images/main-menu.png)

### Projects

From the main menu, you can click on the "Projects" button to access all projects that you are permitted to view or modify. You may also create a new project by clicking on "Projects", then "Create New Project".

For more information about managing your projects, please see the [managing projects](../project) section.

### Pipelines

You can view the pipelines that are installed in IRIDA by clicking on the "Pipelines" button.

For more information about running pipelines, please see the [launching pipelines](../pipelines) section.

### Analyses

After you've launched a pipeline, you can monitor its progress and view results by clicking on the "Analyses" button.

For more information about viewing pipeline results and working with analysis, please see the [viewing pipeline results](../pipelines/#viewing-pipeline-results) section.

### Users

From the main menu, you can click on the "Users" button to access and manage user groups. You may create a new user group by clicking on "Users", then "Create Group".

For more information about managing user groups, please see the [managing user groups](../user-groups) section.

Cart
----

The cart is a temporary area to keep a collection of samples that you intend to submit for use in a pipeline execution. The dashboard provides a quick summary of the contents of your cart on the top, right-hand corner of the page:

![The cart button in the dashboard.](images/cart.png)

You can click on the cart button to reveal more information about the contents of your cart:

![Viewing the contents of the cart.](images/cart-contents.png)

For more information about using the cart, please see the [launching pipelines](../pipelines) section, and the [managing samples](../samples) section.

Remote instances of IRIDA
-------------------------
Remote instances of IRIDA can be used as data sources for associated projects and worklows.  The "Remote IRIDA Connections" section allows users to connect to remote instances of IRIDA.  

**Note**: You must have been provided with a username and password for a remote instance of IRIDA before you can use the data located on that instance.

![Remote API button](images/remote-api-dash.png)

Administrators can add or remove available remote instances of IRIDA from this menu.  Details can be found in the [administrator guide](../../administrator/#remote-instances-of-irida).

### Connecting to remote instances of IRIDA

The Remote Connections list will show you all configured remote instances of IRIDA.  To connect, click the "Connect" button next to the right of the connection status.

![Remote API list](images/api-list.png)

If you have never connected to the remote IRIDA instance before, or your login has expired, you will be shown a login window for the remote site.  Enter your login credentials for that site.  The username and password that you use to connect to a remote instance of IRIDA are different than the username and password that you used to log in to the local site.

![Remote API login page](images/remote-login.png)

You will be shown an authorization page.  Read the details and click "Authorize" to connect to the API.

![OAuth2 approval](images/oauth-approval.png)

You will be shown a confirmation and your browser will reload the current page.  You should now be connected to the remote installation.

User Settings
-------------

The settings menu allows you to view and edit the details of your own user account. This menu also allows you to update your email subscription preferences.  You can find the settings menu in the top, right-hand corner of the page, if you have a [Gravatar](https://en.gravatar.com/) account associated with your email in IRIDA, your gravatar will be displayed:

![The settings menu in the dashboard.](images/settings.png)

For more information about the user settings page, see the [user settings page](user.html).

Logout
------

Once you've finished working with IRIDA, we strongly recommend that you log out, especially if you are using a shared computer.

You can log out of IRIDA by clicking on the <img src="images/logout-icon.png" alt="logout icon" class="inline"> in the top, right-hand corner of the page:

![The logout button in the dashboard.](images/logout.png)

Recent Activities
-----------------<commit_msg>Removed Remote API wording.<commit_after>---
layout: default
title: "Dashboard Overview"
search_title: "IRIDA Dashboard Overview"
description: "An overview of the features present on the IRIDA dashboard."
---

IRIDA Dashboard Overview
========================
{:.no_toc}

The IRIDA dashboard is the main location for accessing all of the data management and pipeline execution functionality built into IRIDA. This document describes the general features of the IRIDA dashboard.

* this comment becomes the TOC
{:toc}

Main Dashboard
--------------

The main IRIDA dashboard has several different areas:

* The [main menu](#main-menu), for accessing and managing data and pipelines,
* The [cart](#cart), for data selections,
* The [user settings](#user-settings) menu,
* The [logout](#logout) button,
* The [recent activities](#recent-activities) section, and
* The [updates](#updates-announcements) section.

![The main IRIDA dashboard.](images/dashboard.png)

Main Menu
---------

The main menu area is at the top, left-hand side of the IRIDA dashboard:

![The main menu in the dashboard.](images/main-menu.png)

### Projects

From the main menu, you can click on the "Projects" button to access all projects that you are permitted to view or modify. You may also create a new project by clicking on "Projects", then "Create New Project".

For more information about managing your projects, please see the [managing projects](../project) section.

### Pipelines

You can view the pipelines that are installed in IRIDA by clicking on the "Pipelines" button.

For more information about running pipelines, please see the [launching pipelines](../pipelines) section.

### Analyses

After you've launched a pipeline, you can monitor its progress and view results by clicking on the "Analyses" button.

For more information about viewing pipeline results and working with analysis, please see the [viewing pipeline results](../pipelines/#viewing-pipeline-results) section.

### Users

From the main menu, you can click on the "Users" button to access and manage user groups. You may create a new user group by clicking on "Users", then "Create Group".

For more information about managing user groups, please see the [managing user groups](../user-groups) section.

Cart
----

The cart is a temporary area to keep a collection of samples that you intend to submit for use in a pipeline execution. The dashboard provides a quick summary of the contents of your cart on the top, right-hand corner of the page:

![The cart button in the dashboard.](images/cart.png)

You can click on the cart button to reveal more information about the contents of your cart:

![Viewing the contents of the cart.](images/cart-contents.png)

For more information about using the cart, please see the [launching pipelines](../pipelines) section, and the [managing samples](../samples) section.

Remote instances of IRIDA
-------------------------
Remote instances of IRIDA can be used as data sources for associated projects and worklows.  The "Remote IRIDA Connections" section allows users to connect to remote instances of IRIDA.  

**Note**: You must have been provided with a username and password for a remote instance of IRIDA before you can use the data located on that instance.

![Remote instances button](images/remote-api-dash.png)

Administrators can add or remove available remote instances of IRIDA from this menu.  Details can be found in the [administrator guide](../../administrator/#remote-instances-of-irida).

### Connecting to remote instances of IRIDA

The Remote Connections list will show you all configured remote instances of IRIDA.  To connect, click the "Connect" button next to the right of the connection status.

![Remote instances list](images/api-list.png)

If you have never connected to the remote IRIDA instance before, or your login has expired, you will be shown a login window for the remote site.  Enter your login credentials for that site.  The username and password that you use to connect to a remote instance of IRIDA are different than the username and password that you used to log in to the local site.

![Remote instance login page](images/remote-login.png)

You will be shown an authorization page.  Read the details and click "Authorize" to connect to the API.

![OAuth2 approval](images/oauth-approval.png)

You will be shown a confirmation and your browser will reload the current page.  You should now be connected to the remote installation.

User Settings
-------------

The settings menu allows you to view and edit the details of your own user account. This menu also allows you to update your email subscription preferences.  You can find the settings menu in the top, right-hand corner of the page, if you have a [Gravatar](https://en.gravatar.com/) account associated with your email in IRIDA, your gravatar will be displayed:

![The settings menu in the dashboard.](images/settings.png)

For more information about the user settings page, see the [user settings page](user.html).

Logout
------

Once you've finished working with IRIDA, we strongly recommend that you log out, especially if you are using a shared computer.

You can log out of IRIDA by clicking on the <img src="images/logout-icon.png" alt="logout icon" class="inline"> in the top, right-hand corner of the page:

![The logout button in the dashboard.](images/logout.png)

Recent Activities
-----------------
{'fraction_non_alphanumeric': 0.0873552570634553, 'fraction_numerical': 0.00018527095877721167, 'mean_word_length': 4.182909265482477, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5979480', 'n_tokens_mistral': 2780, 'n_tokens_neox': 2622, 'n_words': 1501}