diff --git a/docs/user/Flat/genomes_metadata.md b/docs/user/Flat/genomes_metadata.md index 08e0eb13..3d74ee8f 100644 --- a/docs/user/Flat/genomes_metadata.md +++ b/docs/user/Flat/genomes_metadata.md @@ -6,9 +6,9 @@ You can inject metadata, previously added with the `metadata` command, into geno Metadata is integrated into the attributes column of the GFF file. The patterns for adding metadata are as follows: -- In CDS lines, metadata associated with genes follow this pattern: `gene__=`. Gene family metadata follows a similar pattern: `gene__=`. -- In the contig lines of type `region` describing the contig, genome metadata is added with the pattern: `genome__=`, and contig metadata is added with: `contig__=`. -- In RGP lines, metadata is added using the pattern: `rpg__=`. +- In CDS lines, metadata associated with genes follow this pattern: `gene__=`. Gene family metadata follows a similar pattern: `gene__=`. +- In the contig lines of type `region` describing the contig, genome metadata is added with the pattern: `genome__=`, and contig metadata is added with: `contig__=`. +- In RGP lines, metadata is added using the pattern: `rpg__=`. For example, if we associate metadata is associated with the gene family DYB08_RS16060 with the source `pfam`: @@ -35,12 +35,22 @@ A gene belonging to this family would have the following attribute in its GFF li NC_010404.1 external CDS 77317 77958 . - 0 ID=ABAYE_RS00475;Parent=gene-ABAYE_RS00475;product=putative metallopeptidase;family=DYB08_RS16060;partition=persistent;rgp=NC_010404.1_RGP_0;family_pfam_accession=PF18894;family_pfam_description=This entry represents a probable metallopeptidase domain found in a variety of phage and bacterial proteomes.;family_pfam_type=domain ``` -### Metadata in Proksee Visualization +#### Metadata in Proksee Visualization -Metadata can be seamlessly incorporated into Proksee JSON MAP files, enriching the visualization experience. These metadata details become accessible by simply hovering the mouse over the features. +Metadata can be seamlessly incorporated into Proksee JSON MAP files. These metadata details become accessible by simply hovering the mouse over the features. For instance, with the metadata previously added to the DYB08_RS16060 gene family, the Proksee visualization would resemble the example below: ```{image} ../_static/proksee_metadata_example.png :align: center ``` + + +#### Metadata in Table output + +Metadata is seamlessly incorporated into table output with the addition of extra columns. These columns follow the GFF attribute naming: + +- gene metadata: `gene__` +- family metadata: `gene__` + + diff --git a/docs/user/Outputs.md b/docs/user/Outputs.md index 7a9876c9..e59da716 100644 --- a/docs/user/Outputs.md +++ b/docs/user/Outputs.md @@ -23,13 +23,13 @@ When using the same subcommand (like 'write_pangenome' or 'draw' that can help y ```{include} Figures/spots.md ``` -## Rarefaction +### Rarefaction ```{include} Figures/rarefaction.md ``` -## `write_pangeome`: Write flat output describing the pangenome +## Write flat outputs describing the pangenome -Writes 'flat' files that describe the pangenome and its elements. +Writes 'flat' files that describe the pangenome and its elements with the command `write_pangenome`. ### Organisms statistics ```{include} Flat/orgStat.md @@ -65,23 +65,23 @@ The pangenome's graph can be given through multiple data formats, in order to ma ```{include} Flat/module.md ``` -### partitions +### Partitions ```{include} Flat/partition.md ``` -## `write_genomes`: Write genomes with pangenome annotations +## Write genomes with pangenome annotations -Writes 'flat' files that represent the genomes along with their associated pangenome elements. +Writes 'flat' files that represent the genomes along with their associated pangenome elements with command `write_genomes`. -### tables +### Table with pangenome annotations ```{include} Flat/tables.md ``` -### gff +### GFF file ```{include} Flat/gff.md ``` -### proksee +### JSON Map for Proksee visualisation ```{include} Flat/proksee.md ``` ### Adding Fasta Sequences into GFF and proksee JSON map Files @@ -92,6 +92,7 @@ Writes 'flat' files that represent the genomes along with their associated pange ### Incorporating Metadata into Tables, GFF, and Proksee Files ```{include} Flat/genomes_metadata.md ``` + ## Fasta ```{include} sequence/fasta.md ```