Difference between revisions of "Template:Infobox genome/doc"
Jump to navigation
Jump to search
imported>Rotideypoc41352 m (Added cat and interwiki comments) |
imported>Rotideypoc41352 (→Purpose: capitalization →TemplateData: filled parts of it out based on existing template code and documentation) |
||
| Line 3: | Line 3: | ||
== Purpose == | == Purpose == | ||
| − | This template produces a table describing the information about the [[ | + | This template produces a table describing the information about the [[genome]] of a given organism. |
== Usage == | == Usage == | ||
| Line 31: | Line 31: | ||
{ | { | ||
"params": { | "params": { | ||
| − | "image": {}, | + | "image": { |
| + | "description": "Karyotype, for instance", | ||
| + | "example": "File:Example.png" | ||
| + | }, | ||
"image_size": {}, | "image_size": {}, | ||
| − | "caption": {}, | + | "caption": { |
| − | "taxId": {}, | + | "type": "string" |
| − | "type": {}, | + | }, |
| − | "ploidy": {}, | + | "taxId": { |
| − | "size": {}, | + | "description": "genome ID on NCBI Genome website (or another type of ID if type parameter is set to different value)", |
| − | "chromosomes": {}, | + | "example": "51", |
| + | "type": "string" | ||
| + | }, | ||
| + | "type": { | ||
| + | "description": "type of NCBI ID", | ||
| + | "example": "nucleotide", | ||
| + | "type": "string", | ||
| + | "default": "genome" | ||
| + | }, | ||
| + | "ploidy": { | ||
| + | "example": "haploid, diploid or polypoloid", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "size": { | ||
| + | "description": "Size of genome in Mb", | ||
| + | "type": "number" | ||
| + | }, | ||
| + | "chromosomes": { | ||
| + | "description": "number of chromosome pairs", | ||
| + | "example": "23", | ||
| + | "type": "number" | ||
| + | }, | ||
"year": {}, | "year": {}, | ||
"organelle": {}, | "organelle": {}, | ||
"organelle-size": {}, | "organelle-size": {}, | ||
| − | "organelle-year": {} | + | "organelle-year": {}, |
| + | "ucsc_assembly": {} | ||
}, | }, | ||
| − | "description": " | + | "description": "GenomeInfo for short, this template produces a table describing the information about the genome of a given organism.", |
"format": "block" | "format": "block" | ||
} | } | ||
</templatedata> | </templatedata> | ||
Revision as of 17:44, 6 May 2020
| 40px | This is a documentation subpage for Template:Infobox genome. It contains usage information, categories and other content that is not part of the original template page. |
Purpose
This template produces a table describing the information about the genome of a given organism.
Usage
Template:Parameter names example
{{Infobox genome <!-- a.k.a GenomeInfo for short -->
| image = <!-- Karyotype, for instance -->
| caption =
| type = <!-- defaults to "genome", can be "nucleotide" or anything too -->
| taxId = <!-- genome ID on NCBI Genome website -->
| ploidy = <!-- haploid, diploid or polypoloid -->
| chromosomes = <!-- number (unit is pairs) -->
| size = <!-- number (unit is Mb) -->
| year =
| organelle = <!-- type of organelle sequenced -->
| organelle-size = <!-- number (unit is Mb) -->
| organelle-year = <!-- year of sequencing of organelle -->
}}
GenomeInfo for short, this template produces a table describing the information about the genome of a given organism.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Image | image | Karyotype, for instance
| Unknown | optional |
| Image_size | image_size | no description | Unknown | optional |
| Caption | caption | no description | String | optional |
| TaxId | taxId | genome ID on NCBI Genome website (or another type of ID if type parameter is set to different value)
| String | optional |
| Type | type | type of NCBI ID
| String | optional |
| Ploidy | ploidy | no description
| String | optional |
| Size | size | Size of genome in Mb | Number | optional |
| Chromosomes | chromosomes | number of chromosome pairs
| Number | optional |
| Year | year | no description | Unknown | optional |
| Organelle | organelle | no description | Unknown | optional |
| Organelle-size | organelle-size | no description | Unknown | optional |
| Organelle-year | organelle-year | no description | Unknown | optional |
| Ucsc_assembly | ucsc_assembly | no description | Unknown | optional |