PrintStateNotes: Print State Notes

Description Usage Arguments Value Author(s) Examples

Description

Print State Notes

Usage

1
2
PrintStateNotes(notes, taxaNames = NULL, taxaItalic = taxaNames,
  charId = character(0), Format = I)

Arguments

notes

Named character vector, with names corresponding to terminal taxa, and values corresponding to character coding notes for each taxon in turn. This matches the format given by 'ReadNotes(filename)[[character_number]][[2]]'.'

taxaNames

Character vector specifying names of taxa.

taxaItalic

Character vector corresponding to taxaNames, but using '_'underscores'_' to denote italic text where required.

charId

Character or integer identifying the character, for use in the resultant div's ID attribute.

Format

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

Value

Text listing the character coding notes for each taxon, ready for inclusion in a markdown source document

Author(s)

Martin R. Smith

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
## Not run: 
  notes <- ReadNotes(filename)
  character_1_notes <- notes[[1]]
  cat("Character 1")

  PrintStateNotes(character_1_notes[[2]])
  
## End(Not run)
}

ms609/MorphoBank documentation built on April 30, 2021, 4:12 p.m.