mindr (version 1.2.3)

markmapOption: Options for markmap creation

Description

This function is taken from https://github.com/seifer08ms/Rmarkmap.

Usage

markmapOption(
  preset = NULL,
  nodeHeight = 20,
  nodeWidth = 180,
  spacingVertical = 10,
  spacingHorizontal = 120,
  duration = 750,
  layout = "tree",
  color = "gray",
  linkShape = "diagonal",
  renderer = "boxed",
  ...
)

Arguments

preset

the name of built-in theme for markmap. If present, any other parameters will be ignored.

nodeHeight

the height of nodes in the markmap.

nodeWidth

the width of nodes in the markmap.

spacingVertical

space of vertical.

spacingHorizontal

space of horizontal.

duration

duration time for animation.

layout

layout mode of makrmap. Currently, only 'tree' is accepted.

color

color of markmap. A character color value ,either 'gray' or a categorical colors including 'category10','category20','category20b' and 'category20c'.

linkShape

link shape of markmap. A character value, either 'diagonal' or 'bracket'.

renderer

rendered shaped of markmap. A character value ,either 'basic' or 'boxed'.

...

other options.

Functions

• markmapOption: Options for markmap creation

Details

Currently,markmap have 'default' and 'colorful' themes. 'colorful' themes have three different parameters from default themes: nodeHeight: 10, renderer: 'basic',color: 'category20'

See Also

https://github.com/dundalek/markmap/blob/master/lib/view.mindmap.js for details.

Examples

# NOT RUN {
path <- system.file('examples/md', package = 'mindr')
markmap(path = path, remove_curly_bracket = TRUE,
  options = markmapOption(preset = 'colorful')) # 'colorful' theme
markmap(path = path, remove_curly_bracket = TRUE,
  options = markmapOption(color = 'category20b',
    linkShape = 'bracket')) # 'colorful' theme
markmap(path = path, remove_curly_bracket = TRUE,
  options = markmapOption(color = 'category20b',
    linkShape = 'diagonal',
    renderer = 'basic')) # 'colorful' theme
# }