Skip to content

Commit ae497ba

Browse files
committed
Add skeleton documentation for Assembly Page
1 parent ed44b30 commit ae497ba

15 files changed

Lines changed: 87 additions & 2 deletions
561 KB
Loading
35.5 KB
Loading
90.5 KB
Loading
15.2 KB
Loading
74 KB
Loading
156 KB
Loading

docs/core.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ authors:
66
date: 2025-06-03
77
---
88

9-
G-nom core is the core webb application written in [Laravel](https://laravel.com/). G-nom core handles all data storage and import and provides the base web interface. G-nom core is available in our [Github respository](https://github.com/G-nom-Project/g-nom).
9+
G-nom core is the core web application written in [Laravel](https://laravel.com/). G-nom core handles all data storage and import and provides the base web interface. G-nom core is available in our [Github respository](https://github.com/G-nom-Project/g-nom).

docs/signup.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Most of G-nom's functionality is tied to personal user accounts. You can create a new user account using your name and e-mail address at the URL `/register`.
2+
3+
!!! note "Self-signup"
4+
5+
Admins can disable self-signup at their discretion. In this case contact your administrator to create an account manually for you.
6+
7+
Depending on your G-nom configuration, you may receive an e-mail to verify your e-mail address.

docs/user-guide/assembly-card.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
![Assembly Card](../assets/screenshots/assemblycard.png){ align=left }
2+
3+
The assembly card displays an image relevant to the taxon as well as a short, taxon-specific info text. The padlock icon next to the name indicates the public acessibility of the assembly. An open lock indicates access to all user, while a closed lock indicates access limited to the currently logged in user or their team.
4+
5+
The corresponding assembly can be [accessed](./assembly-page.md) and bookmarked directly using the provided buttons.
6+
7+
Availability of certain [G-nom core analyses](../plugins.md) is indicated directly on the assembly card. The BUSCO completeness score is included directly on the assembly card, while Repeatmasker and taXaminer, alongside Annotations and Mappings, are only available as counts.

docs/user-guide/assembly-page.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Intro section
2+
The first section of the assembly page is made up of a grey band detailing scientific name and the custom name of the assembly. A silouette of the species can be supplied via SVG at source e.g. from [Phylopic](https://www.phylopic.org/).
3+
![Assembly Head](../assets/screenshots/AssemblyPage.png){ align=center }
4+
The first section below the band details taxon specific information. These include an image, scientifc and common names as well a short header text and longer info text. The complete NCBI lineage is displayed in a separate field.
5+
6+
The remainder of the page is made up of four collapsible sections, which will be discussed in detail below:
7+
8+
1. Assembly Information
9+
2. Annotation completeness
10+
3. Taxonomic classification
11+
4. Genome Browser
12+
13+
## Assembly Information
14+
![Assembly Collapsible](../assets/screenshots/AssemblyPageCollapsible1.png){ align=center }
15+
The assembly information sections contains G-nom internal information as well common quality metrics and statistics. This includes sequence and contig size statistics as well as N50 and GC content. To assess the completeness of the assembly / related annotation, please check out the BUSCO and fCAT results in the next section.
16+
17+
## Annotation completeness
18+
![Assembly BUSCO](../assets/screenshots/AssemblyPageBUSCO.png){ align=center }
19+
The annotation completeness section presents visualizations for BUSCO and fCAT results. The plot differentiates between Complete (Single-copy), Complete (Duplicated), fragmented and missing. Please refer to the documentation of the underlying tools ([BUSCO](https://busco.ezlab.org/busco_userguide.html#interpreting-the-results) | [fCat](https://f1000research.com/posters/11-1091)) for guidance on how to interpret the results.
20+
21+
## Taxonomic assignment :material-account-hard-hat-outline:
22+
!!! warning taXaminer-dashboard
23+
24+
The taXaminer-dashboard project is currently being re-structured to be published as a singular react component. This feature should be considered unstable until the migration is complete.
25+
26+
27+
The taxonomic assignment section includes the complete [dashboard](https://github.com/BIONF/taxaminer-dashboard) for the visualization of taXaminer results. Additionally, it integrates with you G-nom account and the genome browser.
28+
29+
30+
## Genome Browser
31+
![Assembly Browser](../assets/screenshots/AssemblyPageBrowser.png){ align=center }
32+
The genome browser section embeds a smaller version of the [JBrowse](https://jbrowse.org/jb2/) genome browser. Per default, all available tracks will be loaded. It links to selected genes in the taXaminer dashboard, allowing you to explore the genomic neighbourhood. For detailed investigation of browser tracks, consider using the [Full-screen browser](/user-guide/browser/).

0 commit comments

Comments
 (0)