> For the complete documentation index, see [llms.txt](https://academy.dnanexus.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.dnanexus.com/mlaccelerator/dataprofiler/introductiondataprofiler.md).

# Introduction to Data Profiler

*A license is required to access the Data Profiler on the DNAnexus Platform. For more information, please contact DNAnexus Sales (via <sales@dnanexus.com>).*

### What is the Data Profiler?

The Data Profiler is an app within the DNAnexus Tool Library that supports data cleaning and harmonization. It surfaces interactive visualizations on data quality, data coverage, and descriptive statistics to help you understand and identify potential data issues. It also provides customizable visualization using simple drag-and-drop functionality, for deeper exploration beyond the standard metrics. The Data Profiler gives you the power to quickly evaluate the readiness of your data for downstream analysis.

### Why use the Data Profiler?

Data profiling is the first step in informed decision-making, allowing experts to fully understand the data before downstream analysis. From data collection and cleaning to feature engineering, the team must continuously profile the data to understand its evolution and maintain consistent quality throughout the data transformation process. This ongoing profiling helps identify potential issues early, enabling adjustments that optimize analysis and model performance.&#x20;

The Data Profiler app saves significant time by generating consistent and comprehensive reports on data quality. The Data Profiler app accepts the same input files used to create the databases and datasets for the Apollo Cohort Browser and quickly provides value during data preprocessing.

## Getting Started

A license is required to access the Data Profiler on the DNAnexus Platform. For more information, please contact DNAnexus Sales (via <sales@dnanexus.com>).

### Accessing Data Profiler on DNAnexus Platform

There are two ways to run the application:

1. Direct Access: Go to [this link](https://platform.dnanexus.com/app/data-profiler) to open the app.
2. Platform Navigation: Click on the top navigation bar, then select Open Tools > search for the “Data Profiler” app, and click to run the app.

<img src="https://1979569080-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPtCOm9rXoRi4P9rh1ET8%2Fuploads%2FAYZgnSQe4oAbm7ICTQE3%2Funknown.png?alt=media&amp;token=f50a8d36-ac84-4bf8-8b06-ea7635a8c741" alt="" height="266" width="338">

The app requires no input to launch a job, input files can be specified in the job once it’s ready.

### Open the Data Profiler UI

After launching a job, you will be redirected to the Monitor screen. From there, click the job name to view the job details.

It may take a few minutes for the job to be ready. The Data Remediation Workbench is an [HTTPS application](https://documentation.dnanexus.com/developer/apps/https-applications) on the DNAnexus Platform, so it is accessed via the Job URL. Once the job is ready, click Open Worker URL to open the job UI.&#x20;

If you attempt to click the button before the job is ready, you may encounter a "502 Bad Gateway" error. This is not a problem—it simply means you need to wait a bit longer before the environment is fully prepared.

### Input Specification

To use Data Profiler, you need to provide a dataset name and select the required table data.&#x20;

You can also optionally include the Data dictionary, Entity dictionary, and Coding data (similar to those needed for Apollo data ingestion with the Data Model Loader). See the table below for more details.

<img src="https://1979569080-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPtCOm9rXoRi4P9rh1ET8%2Fuploads%2FcLnSqBbPa1eDehDC3W8A%2Funknown.png?alt=media&amp;token=2296eaa9-217c-4d5f-8c33-bab5a2ec4965" alt="" height="415" width="390">

You can provide input data by selecting either individual files or an entire folder

| Input name        | <p>Required/</p><p>Optional</p> | Input format supported                               | Description                                                                                                                                                                                                                                                                                                                                                             |
| ----------------- | ------------------------------- | ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Dataset name      | Required                        | N/A                                                  | Name of your dataset.                                                                                                                                                                                                                                                                                                                                                   |
| Table data        | Required                        | <p>CSV files</p><p>TSV files</p><p>Parquet files</p> | <p>This is the data that will be profiled by this application. Each file is a table in your dataset.</p><p>You can provide input data by selecting individual files or an entire folder. When selecting a folder, all supported files within that folder are included in the dataset.</p>                                                                               |
| Data dictionary   | Optional                        | A CSV file                                           | <p>The Data Dictionary file of the dataset. This file follows the format of DNAnexus Data Model Loader dictionary (<a href="https://documentation.dnanexus.com/developer/ingesting-data/data-model-loader/data-file-inputs-data-model-loader#data-dictionary">Details</a>).</p><p>If not provided, the relationship between tables in the dataset will be inferred.</p> |
| Entity dictionary | Optional                        | A CSV file                                           | The dictionary describes tables/entities that the data files represent ([Details](https://documentation.dnanexus.com/developer/ingesting-data/data-model-loader/data-file-inputs-data-model-loader#entity-dictionary)).                                                                                                                                                 |
| Coding data       | Optional                        | A CSV file                                           | This file must contain the coding\_name header to link categorical fields. These names must match the corresponding values in the Data Dictionary ([Details](https://documentation.dnanexus.com/developer/ingesting-data/data-model-loader/data-file-inputs-data-model-loader#codings)).                                                                                |

### Working with Multiple Datasets

You can work with multiple datasets within a single job, or access datasets that were profiled in previous jobs within the same project.

Each dataset is processed independently, allowing you to:

* Profile data quality for each dataset separately
* Apply different remediation rules or rule sets per dataset
* Manage and review datasets across runs in a consistent workflow

<img src="https://1979569080-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPtCOm9rXoRi4P9rh1ET8%2Fuploads%2FI39XZh1TvFl1raS4Byl1%2Funknown.png?alt=media&amp;token=3b63c3a1-64cf-4720-ba17-73f6c7dc3666" alt="" height="305" width="421">

You can profile multiple datasets and access profile of other&#x20;

### Resources

[Full Documentation](https://documentation.dnanexus.com/)

To create a support ticket if there are technical issues:

1. Go to the Help header (same section where Projects and Tools are) inside the platform
2. Select “Contact Support”
3. Fill in the Subject and Message to submit a support ticket.
