Skip to content

Main content

Biosystematic Key Couplet Reference Check Tool

Audit explicit key-couplet references and terminal flags without identifying a taxon.

Loading tool…

Description

Check identification-key nonterminal references.

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.

Check identification-key nonterminal references.

When to use this tool

Use Biosystematic Key Couplet Reference Check when checking the stated taxonomic source, name-token, date or concept-support convention.

How to use the tool and how it works

  1. Enter coupletIds, targetIds, terminal. Follow any array-alignment requirements below. Use the units and conventions below.
  2. Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
  3. Read missingTargets, selfLoops. Use the output convention below.

Check identification-key nonterminal references. Require aligned coupletIds/targetIds/terminal; missingTargets deduplicates nonterminal targets absent from couplet IDs, selfLoops lists nonterminal row indexes targeting their own couplet.1

Input fieldMeaning and unitsAccepted input
coupletIdsCouplet IdsRequired. Array of text; maximum UTF-16 length 8192; maximum items 256.
targetIdsTarget IdsRequired. Array of text; maximum UTF-16 length 8192; maximum items 256.
terminalTerminalRequired. Array of boolean; maximum items 256.
Output fieldInterpretationReturned shape
missingTargetsNonterminal targets absent from the supplied couplet IDs; longer cycles are not detected.Required. Array of text; maximum UTF-16 length 8192; maximum items 256.
selfLoopsSelf LoopsRequired. Array of safe integer; maximum items 256.
json
{
  "input": {
    "coupletIds": [
      "1a",
      "1b",
      "2a"
    ],
    "targetIds": [
      "2a",
      "taxon-A",
      "3a"
    ],
    "terminal": [
      false,
      true,
      false
    ]
  },
  "output": {
    "missingTargets": [
      "3a"
    ],
    "selfLoops": []
  }
}

Limitations and assumptions

  • This does not detect all cycles, unreachable branches, duplicate couplets or a biologically valid identification key.
  • 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

  1. Calculation and input contract: biosystematics/biosystematic-key-couplet-reference-check — tool.io

Similar or alternative tools