diff --git a/docs/ExportFormats.md b/docs/ExportFormats.md new file mode 100644 index 00000000..65b8ddfd --- /dev/null +++ b/docs/ExportFormats.md @@ -0,0 +1,30 @@ +# Export Formats + +## Summary table CSV export + +The summary table CSV export includes the following columns: + +* `Phyloreference ID`: A URI (absolute, relative or local; may or may not resolve) that identifies this phyloreference. Normally intended for machine consumption. + * Example `#Alligatoridae` +* `Label`: A label for this phyloreference, normally intended for human consumption. + * Example: `Alligatoridae` +* `Type`: The type of this phyloreference. + * May be one of the following values: + * `Apomorphy-based clade definition` + * `Maximum clade definition` + * `Minimum clade definition` + * `Invalid definition (...)` (with the reason for the invalid definition in parentheses) +* `Definition`: The (human readable) clade definition as entered in the `Definition in free-form text`. + * Example: `Last common ancestor of Crocodylus niloticus, Osteolaemus tetraspis, and Tomistoma schlegelii and all of its descendents.` +* `Internal specifier N`: A description of each internal specifier (_N_ is a number starting from 1). + * Example: `Caiman crocodilus` +* `External specifier N`: A description of each external specifier (_N_ is a number starting from 1). + * Example: `Caiman crocodilus` +* `Phylogeny: [Phylogeny label] expected`: The label of the node in the specified phylogeny to which the phyloreference was expected to resolve. + * Example: `Alligatoridae` + * Will be set to `(none)` if no expected node was found. +* `Phylogeny: [Phylogeny label] actual`: The label of the node actually resolved for this phyloreference in the specified phylogeny. + * Example: `Alligatoridae_ott195670` + * Will be set to `(resolution not yet run)` if resolution has not yet been run. + * Will be set to `(could not resolve)` if this phyloreference could not be resolved. + * Will be set to `(unlabelled)` if a node was resolved, but it had no label. \ No newline at end of file diff --git a/src/components/phyx/PhyxView.vue b/src/components/phyx/PhyxView.vue index 9e20f577..70f7c1c6 100644 --- a/src/components/phyx/PhyxView.vue +++ b/src/components/phyx/PhyxView.vue @@ -1,17 +1,12 @@