parseTag: Tag from Rd Format to Markdown

In Rd2md: Markdown Reference Manuals

Description

This function will convert an Rd element to markdown format. Note that links are only supported within a markdown document, referenced with #. Use href to link to external sources.

Usage

parseTag(
  x,
  pre = character(),
  post = character(),
  stripNewline = TRUE,
  stripWhite = TRUE,
  stripTab = TRUE
)

Arguments

x	element from an Rd class.
pre	String to prepend to the parsed tag.
post	String to append to the parsed tag.
stripNewline	Logical indicating whether to strip new line characters.
stripWhite	Logical indicating whether to strip white space.
stripTab	Logical indicating whether to strip tab characters.

Rd2md documentation built on Feb. 2, 2021, 1:07 a.m.