PrintCharacterHeading: Print character heading

PrintCharacterHeadingR Documentation

Print character heading

Description

Prints a character heading using markdown syntax at an appropriate level in the hierarchy.

Usage

PrintCharacterHeading(char, charNo, prevElements = "*NONE*",
  thisElements = strsplit(char, ": ")[[1]], nextElements = "*NONE*",
  forceDisplay = character(0), Format = I)

Arguments

char

Character string specifying the definition of the character

charNo

Character string identifying the character's number

prevElements, thisElements, nextElements

Character description, decomposed into its constituent hierarchichal elements

forceDisplay

Character vector specifying character descriptions to always print as a header when an exact match is encountered.

Format

Function that is passed a character string, and should return the string with appropriate formatting (e.g. italicization of genus names).

Value

A heading for the character in markdown format

Author(s)

Martin R. Smith

Examples

{
  PrintCharacterHeading("Tail: Colour", 1, "NONE",
  c("Tail", "Colour"), c("Tail", "Colour", "Patterning"))
}



ms609/MorphoBank documentation built on June 9, 2024, 6:04 p.m.