Description
Return a type-specimen reference's path depth under a root policy.
Taxonomic names, authorship strings, nomenclatural types and source-defined taxon concepts are related but distinct records. A literal token parser or source-label comparison can preserve a stated convention without resolving accepted taxonomy or establishing compliance with the applicable nomenclatural code.
Return a type-specimen reference's path depth under a root policy.
When to use this tool
Use Type Specimen Reference Depth when checking the stated taxonomic source, name-token, date or concept-support convention.
How to use the tool and how it works
- Enter referenceParts, includeRoot. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read depth. Use the output convention below.
Return a type-specimen reference's path depth under a root policy. depth = max(0,referenceParts.length-(includeRoot ? 0 : 1)).1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| referenceParts | Reference Parts | Required. Array of text; maximum UTF-16 length 8192; maximum items 256. |
| includeRoot | Include Root | Required. Boolean. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| depth | Depth | Required. Safe integer. |
{
"input": {
"referenceParts": [
"repo",
"collection",
"item"
],
"includeRoot": false
},
"output": {
"depth": 2
}
}Limitations and assumptions
- Components and root meaning are supplied; no collection hierarchy, specimen identity or type designation is resolved.
- Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
Alternative or Complementary methods
Consult the original taxonomic treatment and applicable nomenclatural code, and use source-aware taxonomic resolution for accepted names, priority or type status.
References
Similar or alternative tools
- Voucher Type Status Source Gap
Compare voucher status only when its source is declared known.
- Nomenclatural Type Status Source Token
Map a source type-status token through a supplied vocabulary.