Comment on page
Learn to use Table Exporter to extract data from an Apollo Dataset, cohort, or dashboard into a delimited file for use in analysis, or download.
To launch the app, enter this command via the command line:
dx run table-exporter
The Table Exporter app requires as an input:
output: The name of the file to create. Based on the Output File Format, the extension will be added automatically.
Additional optional inputs are:
output_format: [choices: "CSV", "TSV"] [default: "CSV"] The file format to use for the generated file:
- CSV - Comma-separated values
- TSV - Tab-separated values
coding_option: [choices: "REPLACE", "RAW", "EXCLUDE"] [default: "REPLACE"] How to handle coded fields:
- REPLACE - If a coding value exists, replace the raw value with the code.
- RAW - Export the raw values of the field.
- EXCLUDE - If a coding value exists, do not export the value. Most commonly used with sparse fields.
header_style: [choices: "FIELD-NAME", "FIELD-TITLE", "UKB-FORMAT", "NONE"] [default: "FIELD-NAME"] The format to use for the headers in the exported file:
- FIELD-NAME - Use the name of the field in the database.
- FIELD-TITLE - Use the name of the field as shown in the cohort browser.
- NONE - Do not include headers.
- UKB-FORMAT - This assumes the field name follows the pattern p<field id>_i<instance>_a<array>. Names are then converted into UK Biobank style - for example, field
entity: The name of the entity you would like to export. If no entity is specified, the primary entity will be exported.
field_names_file_txt: A file containing the names of the fields to export. Each line should contain one field name. If an entity is specified and field names are not, all fields from the specified entity will be exported. Only one of the following three input options should be provided: “Field Names”, or “Field Titles”, or “File Containing Field Names.” When more than one of these input options is specified, the app will fail with an error message. If all options are left blank, and only an entity is specified, all fields in the entity will be exported.•
field_names: The names of the fields to export. To specify multiple field names in the UI, enter a comma separated string (e.g.
field1,field2,field3...). To specify multiple field names in the CLI, use multiple assignments to the input argument
-ifield_names, like so:
-ifield_names="field1" -ifield_names="field2" -ifield_names="field3". If an entity is specified and field names are not, all fields from the specified entity will be exported.
field_titles: The title of the fields to export. Note that the listed titles should be the field titles (as they shown in the Cohort Browser) when selecting a given field. When running the app through the UI, field titles containing commas should must have a backslash (
\) escape character before the comma, and multiple title entries should be delimited by a comma (e.g.
field1,field2,fielda\,b...). The escape character is not needed while entering comma containing field titles in the CLI. To specify multiple field titles in the CLI, use multiple assignments to the input argument
-ifield_titles, like so:
-ifield_titles="field1" -ifield_titles="field2" -ifield_titles="fielda,b". If an entity is specified and field titles are not, all fields from the specified entity will be exported.
cohort_table_entity_names: The cohort tables, based on entity names, that you would like to export. If no names are specified, all of the cohort tables will be exported.
cohort_table_entity_titles: The cohort tables, based on entity titles, that you would like to export. If no titles are specified, all of the cohort tables are exported.
- If only the Entity field is specified and Field Titles/ or Field Names fields are not specified, all the fields in the specified entity will be exported.
- If both the Entity and Field Titles or Field Names are specified, only the specified fields will be exported.
- If neither Entity nor Field Titles/Names are specified, then:
- If the input is a dashboard or a cohort, the columns specified in the cohort table are used to generate the exported file. One output file for every entity in the dashboard will be created.
- If the input is a Dataset and if the Dataset has a default dashboard, the columns specified in the cohort table of the default dashboard are used to generate the exported file. One output file for every entity in the dashboard will be created.
- If the input is a Dataset and if the Dataset doesn’t have a default dashboard, the primary entity and related fields are used to generate the exported file.
tsv: The generated CSV or TSV file
- For cohort_table_entity_names and cohort_table_entity_titles inputs with cohorts/dashboards containing a
ted_containerthe file naming convention is
- For non
ted_containercohorts/dashboards the naming convention is
- For dataset inputs the naming convention is
- 1.For extremely large entities (thousands of columns with hundreds of thousands of rows), using "Replace" codings will significantly increase runtime and cost. It is recommended that in those instances you export without coding replacement.
- 2.If you are exporting on a dataset that has databases in a controlled project where DB UI View Only permission is set, the application must be run in the project with the restricted database to execute successfully.
- 3.If you encounter a failed job as the result of insufficient disk space, please rerun the job using additional compute resources. I.e, increase the default instance type to have more memory and/or storage.