graph2latex: Graph2LaTeX

In gMCP: Graph Based Multiple Comparison Procedures

Graph2LaTeX

Description

Creates LaTeX code that represents the given graph.

Usage

graph2latex(
  graph,
  package = "TikZ",
  scale = 1,
  showAlpha = FALSE,
  alpha = 0.05,
  pvalues,
  fontsize,
  nodeTikZ,
  labelTikZ = "near start,above,fill=blue!20",
  tikzEnv = TRUE,
  offset = c(0, 0),
  fill = list(reject = "red!80", retain = "green!80"),
  fig = FALSE,
  fig.label = NULL,
  fig.caption = NULL,
  fig.caption.short = NULL,
  nodeR = 25,
  scaleText = TRUE
)

Arguments

graph	A graph of class graphMCP.
package	A character string specifying the LaTeX package that should be used. Up to now only TikZ is available.
scale	A numeric scalar specifying a possible scaling of the graph. It is only used if tikzEnv==TRUE. Note that this does only effect the fontsize of the graph if scaleText==FALSE. (Coordinates are interpreted in big points: 72 bp = 1 inch).
showAlpha	Logical whether local alpha levels or weights should be shown.
alpha	An optional numeric argument to specify the type I error rate.
pvalues	If the optional numeric argument pvalues is given, nodes that can be rejected, will be marked.
fontsize	An optional character vector specifying the fontsize for the graph, must be one of "tiny", "scriptsize", "footnotesize", "small", "normalsize", "large", "Large", "LARGE", "huge" or "Huge".
nodeTikZ	A character string with additional arguments for the TikZ node command like for example nodeTikZ="minimum size=2cm".
labelTikZ	A character string with arguments for the TikZ node command within an edge.
tikzEnv	Logical whether the LaTeX code should be wrapped in a TikZ environment.
offset	A numeric of length 2 specifying the x and y offset in the TikZ environment.
fill	A list containing 2 elements reject and retain specifying node fill colour of rejected and retained (or not yet rejected) nodes.
fig	Logical whether a figure environment should be created.
fig.label	Label for figure environment (if fig==TRUE).
fig.caption	Caption for figure environment (if fig==TRUE).
fig.caption.short	Optional short version of fig.caption for list of figures (if fig==TRUE).
nodeR	Radius of nodes (pixel in Java, bp in LaTeX).
scaleText	Only used if scale is unequal 1 and tikzEnv==TRUE. If scaleText is TRUE (the default) a scalebox environment is used. If it is FALSE the optional parameter scale from the tikzpicture environment is used and font size will not change. Note that while you easily can change the scale in the scalebox environment, it is more problematic to adjust the scale in the tikzpicture environment afterwards in the LaTeX document, since for curved edges the parameters are calculated for a certain relative node size which changes if the graph is scaled but the text size stays the same.

Details

For details see the given references.

Value

A character string that contains LaTeX code representing the given graph.

Author(s)

Kornelius Rohmeyer [e-mail]

References

The TikZ and PGF Packages Manual for version 2.00, Till Tantau, https://www.ctan.org/pkg/pgf/

See Also

graphMCP, gMCPReport

Examples

g <- BonferroniHolm(5)

graph2latex(g)

gMCP documentation built on May 29, 2024, 9:37 a.m.