flat.md
In transltr: Support Many Languages in R

_deserialize() validates string

Code
  flat_deserialize(1L)
Condition
  Error:
  ! 'string' must be a non-NA character of length 1.

_deserialize() validates tag_sep

Code
  flat_deserialize(tag_sep = 1L)
Condition
  Error:
  ! 'tag_sep' must be a non-NA and non-empty character of length 1.

_deserialize() throws an error if a node has another child node

Code
  # This is an invalid FLAT object.
  invalid <- ":: Level: Node\n\na\n\n:: Level: Node: Lower node\n\nb"
  cat(invalid, "\n")
Output
  :: Level: Node

  a

  :: Level: Node: Lower node

  b 
Code
  flat_deserialize(invalid)
Condition
  Error:
  ! 'string' has an invalid structure. Check 'Level: Node' tags.

_tag() validates x

Code
  flat_tag(1L)
Condition
  Error:
  ! 'x' must be a list.

_tag() validates tag_sep

Code
  flat_tag(tag_sep = 1L)
Condition
  Error:
  ! 'tag_sep' must be a non-NA and non-empty character of length 1.

_tag() validates tag_empty

Code
  flat_tag(tag_empty = 1L)
Condition
  Error:
  ! 'tag_empty' must be a non-NA character of length 1.

_format() validates x

Code
  flat_format(1L)
Condition
  Error:
  ! 'x' must be a list.

_example() prints the example before returning

Code
  flat_example()
Output
  # The FLAT (Flat List As Text) Format
  #
  # What follows after an octothorpe is a comment and is ignored.

  :: Tags: Introduction

  Tags begin by two colons and starts a new section.

  :: Tags: Sections

  This is a section. It contains a textual representation of a child element.

  :: Tags: Creating Them

  Tags are constructed from names extracted from the original object.

  :: Tags: [4]

  Missing names are substituted by a numbered standard label automatically.

  :: Comments

  What follows after an octothorpe is treated as a comment and is ignored.
  # This is a comment.                                                    
  Inline comments are also allowed. # This is a comment.                  
  Escape octothorpes (\#) to treat them as regular characters.