Enhancing tabular dataset previews in reports/pages

There are a number of options, specifically for tabular data, that can allow it to render more nicely in your workflow reports and pages and anywhere that GalaxyMarkdown is used.

• title to give your table a title
• footer allows you to caption your table
• show_column_headers=false to hide the column headers
• compact=true to make the table show up more inline, hiding that it was embedded from a Galaxy dataset.

The existing history_dataset_display directive displays the dataset name and some useful context at the expense of potentially breaking the flow of the document

Input: Galaxy Markdown

```galaxy
history_dataset_display(history_dataset_id=1e8ab44153008be8) 
```

Output: Example Screenshot

The existing history_dataset_embedded directive was implemented to try to inline results more and make the results more readable within a more… curated document. It is dispatches on tabular types and puts the results in a table but the table doesn’t have a lot of options.

Input: Galaxy Markdown

```galaxy
history_dataset_embedded(history_dataset_id=1e8ab44153008be8) 
```

Output: Example Screenshot

The history_dataset_as_table directive mirrors the history_dataset_as_image directive: it tries harder to coerce the data into a table and provides new table—specific options. The first of these is “show_column_headers which defaults to true`.

Input: Galaxy Markdown

```galaxy
history_dataset_as_table(history_dataset_id=1e8ab44153008be8,show_column_headers=false)
```

Output: Example Screenshot

There is also a compact option. This provides a much more inline experience for tabular datasets:

Input: Galaxy Markdown

```galaxy
history_dataset_as_table(history_dataset_id=1e8ab44153008be8,show_column_headers=false,compact=true)
```

Output: Example Screenshot

Figures in general should have titles and legends — so there is the “title” and “footer” options also.

Input: Galaxy Markdown

```galaxy
history_dataset_as_table(history_dataset_id=1e8ab44153008be8,show_column_headers=false,title='Binding Site Results',footer='Here is a very good figure caption for this table.')
```

Output: Example Screenshot

Still have questions?

Want to embed this snippet (FAQ) in your GTN Tutorial?

{% snippet  faqs/galaxy/reports_tables.md %}

Persistent URL