Complete canonical API text; task articles explain the workflows. Tutorials
Site guide · find your task
Setup and learning paths
HomeInstall and prepare the environmentChoose your learning moduleModule I · Chord
1.1 Tables and field meanings1.2 Produce and import comparisons1.3 Build the layers step by step1.4 Direction, curvature and clearance1.5 Filter and summarize links1.6 Full source-file workflow1.7 Complete chord showcaseModule II · Collinear
2.1 Reuse chord input tables2.2 Switch coordinates and add layers2.3 Routes, clearance and the ruler2.4 Compare CDS neighbourhoods2.5 Focus, anchors and segments2.6 Complete collinear showcaseModule III · Plasmid
3.1 DNA, annotations and 13 references3.2 From a circle to annotation layers3.3 Features, primers and restriction3.4 Thirteen plasmid references3.5 Complete plasmid casesConsult as needed · Data and layers
Prepare tables and coordinatesImport and convert dataImport nucleotide and protein alignmentsProject protein intervals to genomic coordinatesFeatures, stacking and genomic decorationLabels and local placementQuantitative tracksMappings, scales, guides and themesSet values by sequence and strandCommon adjustments and grammarExport, preview and diagnosticsLearning map and reference
Articles and complete workflowsFunction referenceReproducible galleryFrequently asked questionsMigrate to the candidate APITerminology and design sourcesDevelopment status and changesComplete themes for chord diagrams. Besides ordinary ggplot2 theme elements, these functions control automatic sequence axes, chord labels and the appearance and placement of guides belonging to each ggchord role. Palettes, breaks, labels and guide ordering remain scale/guide concerns.
Usage
Code
theme_ggchord(
axis = NULL,
axis.line = NULL,
axis.ticks = NULL,
axis.minor.ticks = NULL,
axis.text = NULL,
axis.gap = NULL,
axis.ticks.length = NULL,
axis.minor.ticks.length = NULL,
axis.text.offset = NULL,
axis.text.orientation = NULL,
axis.text.check.overlap = NULL,
seq.label = NULL,
gene.label = NULL,
gene.label.segment = NULL,
feature.label = NULL,
feature.label.segment = NULL,
restriction.label = NULL,
restriction.label.segment = NULL,
seq.center.label = NULL,
seq.center.name = NULL,
seq.center.length = NULL,
legend.seq = NULL,
legend.seq.position = NULL,
legend.seq.direction = NULL,
legend.seq.background = NULL,
legend.seq.key = NULL,
legend.seq.key.size = NULL,
legend.seq.key.width = NULL,
legend.seq.key.height = NULL,
legend.seq.text = NULL,
legend.seq.text.position = NULL,
legend.seq.title = NULL,
legend.seq.title.position = NULL,
legend.seq.margin = NULL,
legend.seq.spacing = NULL,
legend.link = NULL,
legend.link.position = NULL,
legend.link.direction = NULL,
legend.link.background = NULL,
legend.link.key = NULL,
legend.link.key.size = NULL,
legend.link.key.width = NULL,
legend.link.key.height = NULL,
legend.link.text = NULL,
legend.link.text.position = NULL,
legend.link.title = NULL,
legend.link.title.position = NULL,
legend.link.margin = NULL,
legend.link.spacing = NULL,
legend.ribbon = NULL,
legend.ribbon.position = NULL,
legend.ribbon.direction = NULL,
legend.ribbon.background = NULL,
legend.ribbon.key = NULL,
legend.ribbon.key.size = NULL,
legend.ribbon.key.width = NULL,
legend.ribbon.key.height = NULL,
legend.ribbon.text = NULL,
legend.ribbon.text.position = NULL,
legend.ribbon.title = NULL,
legend.ribbon.title.position = NULL,
legend.ribbon.margin = NULL,
legend.ribbon.spacing = NULL,
legend.ribbon.ticks = NULL,
legend.ribbon.ticks.length = NULL,
legend.ribbon.axis.line = NULL,
legend.gene = NULL,
legend.gene.position = NULL,
legend.gene.direction = NULL,
legend.gene.background = NULL,
legend.gene.key = NULL,
legend.gene.key.size = NULL,
legend.gene.key.width = NULL,
legend.gene.key.height = NULL,
legend.gene.text = NULL,
legend.gene.text.position = NULL,
legend.gene.title = NULL,
legend.gene.title.position = NULL,
legend.gene.margin = NULL,
legend.gene.spacing = NULL,
legend.feature = NULL,
legend.feature.position = NULL,
legend.feature.direction = NULL,
legend.feature.background = NULL,
legend.feature.key = NULL,
legend.feature.key.size = NULL,
legend.feature.key.width = NULL,
legend.feature.key.height = NULL,
legend.feature.text = NULL,
legend.feature.text.position = NULL,
legend.feature.title = NULL,
legend.feature.title.position = NULL,
legend.feature.margin = NULL,
legend.feature.spacing = NULL,
legend.region = NULL,
legend.region.position = NULL,
legend.region.direction = NULL,
legend.region.background = NULL,
legend.region.key = NULL,
legend.region.key.size = NULL,
legend.region.key.width = NULL,
legend.region.key.height = NULL,
legend.region.text = NULL,
legend.region.text.position = NULL,
legend.region.title = NULL,
legend.region.title.position = NULL,
legend.region.margin = NULL,
legend.region.spacing = NULL,
...
)
theme_ggchord_minimal(
axis = NULL,
axis.line = NULL,
axis.ticks = NULL,
axis.minor.ticks = NULL,
axis.text = NULL,
axis.gap = NULL,
axis.ticks.length = NULL,
axis.minor.ticks.length = NULL,
axis.text.offset = NULL,
axis.text.orientation = NULL,
axis.text.check.overlap = NULL,
seq.label = NULL,
gene.label = NULL,
gene.label.segment = NULL,
feature.label = NULL,
feature.label.segment = NULL,
restriction.label = NULL,
restriction.label.segment = NULL,
seq.center.label = NULL,
seq.center.name = NULL,
seq.center.length = NULL,
legend.seq = NULL,
legend.seq.position = NULL,
legend.seq.direction = NULL,
legend.seq.background = NULL,
legend.seq.key = NULL,
legend.seq.key.size = NULL,
legend.seq.key.width = NULL,
legend.seq.key.height = NULL,
legend.seq.text = NULL,
legend.seq.text.position = NULL,
legend.seq.title = NULL,
legend.seq.title.position = NULL,
legend.seq.margin = NULL,
legend.seq.spacing = NULL,
legend.link = NULL,
legend.link.position = NULL,
legend.link.direction = NULL,
legend.link.background = NULL,
legend.link.key = NULL,
legend.link.key.size = NULL,
legend.link.key.width = NULL,
legend.link.key.height = NULL,
legend.link.text = NULL,
legend.link.text.position = NULL,
legend.link.title = NULL,
legend.link.title.position = NULL,
legend.link.margin = NULL,
legend.link.spacing = NULL,
legend.ribbon = NULL,
legend.ribbon.position = NULL,
legend.ribbon.direction = NULL,
legend.ribbon.background = NULL,
legend.ribbon.key = NULL,
legend.ribbon.key.size = NULL,
legend.ribbon.key.width = NULL,
legend.ribbon.key.height = NULL,
legend.ribbon.text = NULL,
legend.ribbon.text.position = NULL,
legend.ribbon.title = NULL,
legend.ribbon.title.position = NULL,
legend.ribbon.margin = NULL,
legend.ribbon.spacing = NULL,
legend.ribbon.ticks = NULL,
legend.ribbon.ticks.length = NULL,
legend.ribbon.axis.line = NULL,
legend.gene = NULL,
legend.gene.position = NULL,
legend.gene.direction = NULL,
legend.gene.background = NULL,
legend.gene.key = NULL,
legend.gene.key.size = NULL,
legend.gene.key.width = NULL,
legend.gene.key.height = NULL,
legend.gene.text = NULL,
legend.gene.text.position = NULL,
legend.gene.title = NULL,
legend.gene.title.position = NULL,
legend.gene.margin = NULL,
legend.gene.spacing = NULL,
legend.feature = NULL,
legend.feature.position = NULL,
legend.feature.direction = NULL,
legend.feature.background = NULL,
legend.feature.key = NULL,
legend.feature.key.size = NULL,
legend.feature.key.width = NULL,
legend.feature.key.height = NULL,
legend.feature.text = NULL,
legend.feature.text.position = NULL,
legend.feature.title = NULL,
legend.feature.title.position = NULL,
legend.feature.margin = NULL,
legend.feature.spacing = NULL,
legend.region = NULL,
legend.region.position = NULL,
legend.region.direction = NULL,
legend.region.background = NULL,
legend.region.key = NULL,
legend.region.key.size = NULL,
legend.region.key.width = NULL,
legend.region.key.height = NULL,
legend.region.text = NULL,
legend.region.text.position = NULL,
legend.region.title = NULL,
legend.region.title.position = NULL,
legend.region.margin = NULL,
legend.region.spacing = NULL,
...
)
theme_ggchord_dark(
axis = NULL,
axis.line = NULL,
axis.ticks = NULL,
axis.minor.ticks = NULL,
axis.text = NULL,
axis.gap = NULL,
axis.ticks.length = NULL,
axis.minor.ticks.length = NULL,
axis.text.offset = NULL,
axis.text.orientation = NULL,
axis.text.check.overlap = NULL,
seq.label = NULL,
gene.label = NULL,
gene.label.segment = NULL,
feature.label = NULL,
feature.label.segment = NULL,
restriction.label = NULL,
restriction.label.segment = NULL,
seq.center.label = NULL,
seq.center.name = NULL,
seq.center.length = NULL,
legend.seq = NULL,
legend.seq.position = NULL,
legend.seq.direction = NULL,
legend.seq.background = NULL,
legend.seq.key = NULL,
legend.seq.key.size = NULL,
legend.seq.key.width = NULL,
legend.seq.key.height = NULL,
legend.seq.text = NULL,
legend.seq.text.position = NULL,
legend.seq.title = NULL,
legend.seq.title.position = NULL,
legend.seq.margin = NULL,
legend.seq.spacing = NULL,
legend.link = NULL,
legend.link.position = NULL,
legend.link.direction = NULL,
legend.link.background = NULL,
legend.link.key = NULL,
legend.link.key.size = NULL,
legend.link.key.width = NULL,
legend.link.key.height = NULL,
legend.link.text = NULL,
legend.link.text.position = NULL,
legend.link.title = NULL,
legend.link.title.position = NULL,
legend.link.margin = NULL,
legend.link.spacing = NULL,
legend.ribbon = NULL,
legend.ribbon.position = NULL,
legend.ribbon.direction = NULL,
legend.ribbon.background = NULL,
legend.ribbon.key = NULL,
legend.ribbon.key.size = NULL,
legend.ribbon.key.width = NULL,
legend.ribbon.key.height = NULL,
legend.ribbon.text = NULL,
legend.ribbon.text.position = NULL,
legend.ribbon.title = NULL,
legend.ribbon.title.position = NULL,
legend.ribbon.margin = NULL,
legend.ribbon.spacing = NULL,
legend.ribbon.ticks = NULL,
legend.ribbon.ticks.length = NULL,
legend.ribbon.axis.line = NULL,
legend.gene = NULL,
legend.gene.position = NULL,
legend.gene.direction = NULL,
legend.gene.background = NULL,
legend.gene.key = NULL,
legend.gene.key.size = NULL,
legend.gene.key.width = NULL,
legend.gene.key.height = NULL,
legend.gene.text = NULL,
legend.gene.text.position = NULL,
legend.gene.title = NULL,
legend.gene.title.position = NULL,
legend.gene.margin = NULL,
legend.gene.spacing = NULL,
legend.feature = NULL,
legend.feature.position = NULL,
legend.feature.direction = NULL,
legend.feature.background = NULL,
legend.feature.key = NULL,
legend.feature.key.size = NULL,
legend.feature.key.width = NULL,
legend.feature.key.height = NULL,
legend.feature.text = NULL,
legend.feature.text.position = NULL,
legend.feature.title = NULL,
legend.feature.title.position = NULL,
legend.feature.margin = NULL,
legend.feature.spacing = NULL,
legend.region = NULL,
legend.region.position = NULL,
legend.region.direction = NULL,
legend.region.background = NULL,
legend.region.key = NULL,
legend.region.key.size = NULL,
legend.region.key.width = NULL,
legend.region.key.height = NULL,
legend.region.text = NULL,
legend.region.text.position = NULL,
legend.region.title = NULL,
legend.region.title.position = NULL,
legend.region.margin = NULL,
legend.region.spacing = NULL,
...
)
theme_ggchord_publication(
axis = NULL,
axis.line = NULL,
axis.ticks = NULL,
axis.minor.ticks = NULL,
axis.text = NULL,
axis.gap = NULL,
axis.ticks.length = NULL,
axis.minor.ticks.length = NULL,
axis.text.offset = NULL,
axis.text.orientation = NULL,
axis.text.check.overlap = NULL,
seq.label = NULL,
gene.label = NULL,
gene.label.segment = NULL,
feature.label = NULL,
feature.label.segment = NULL,
restriction.label = NULL,
restriction.label.segment = NULL,
seq.center.label = NULL,
seq.center.name = NULL,
seq.center.length = NULL,
legend.seq = NULL,
legend.seq.position = NULL,
legend.seq.direction = NULL,
legend.seq.background = NULL,
legend.seq.key = NULL,
legend.seq.key.size = NULL,
legend.seq.key.width = NULL,
legend.seq.key.height = NULL,
legend.seq.text = NULL,
legend.seq.text.position = NULL,
legend.seq.title = NULL,
legend.seq.title.position = NULL,
legend.seq.margin = NULL,
legend.seq.spacing = NULL,
legend.link = NULL,
legend.link.position = NULL,
legend.link.direction = NULL,
legend.link.background = NULL,
legend.link.key = NULL,
legend.link.key.size = NULL,
legend.link.key.width = NULL,
legend.link.key.height = NULL,
legend.link.text = NULL,
legend.link.text.position = NULL,
legend.link.title = NULL,
legend.link.title.position = NULL,
legend.link.margin = NULL,
legend.link.spacing = NULL,
legend.ribbon = NULL,
legend.ribbon.position = NULL,
legend.ribbon.direction = NULL,
legend.ribbon.background = NULL,
legend.ribbon.key = NULL,
legend.ribbon.key.size = NULL,
legend.ribbon.key.width = NULL,
legend.ribbon.key.height = NULL,
legend.ribbon.text = NULL,
legend.ribbon.text.position = NULL,
legend.ribbon.title = NULL,
legend.ribbon.title.position = NULL,
legend.ribbon.margin = NULL,
legend.ribbon.spacing = NULL,
legend.ribbon.ticks = NULL,
legend.ribbon.ticks.length = NULL,
legend.ribbon.axis.line = NULL,
legend.gene = NULL,
legend.gene.position = NULL,
legend.gene.direction = NULL,
legend.gene.background = NULL,
legend.gene.key = NULL,
legend.gene.key.size = NULL,
legend.gene.key.width = NULL,
legend.gene.key.height = NULL,
legend.gene.text = NULL,
legend.gene.text.position = NULL,
legend.gene.title = NULL,
legend.gene.title.position = NULL,
legend.gene.margin = NULL,
legend.gene.spacing = NULL,
legend.feature = NULL,
legend.feature.position = NULL,
legend.feature.direction = NULL,
legend.feature.background = NULL,
legend.feature.key = NULL,
legend.feature.key.size = NULL,
legend.feature.key.width = NULL,
legend.feature.key.height = NULL,
legend.feature.text = NULL,
legend.feature.text.position = NULL,
legend.feature.title = NULL,
legend.feature.title.position = NULL,
legend.feature.margin = NULL,
legend.feature.spacing = NULL,
legend.region = NULL,
legend.region.position = NULL,
legend.region.direction = NULL,
legend.region.background = NULL,
legend.region.key = NULL,
legend.region.key.size = NULL,
legend.region.key.width = NULL,
legend.region.key.height = NULL,
legend.region.text = NULL,
legend.region.text.position = NULL,
legend.region.title = NULL,
legend.region.title.position = NULL,
legend.region.margin = NULL,
legend.region.spacing = NULL,
...
)
theme_ggchord_plasmid(
axis = NULL,
axis.line = NULL,
axis.ticks = NULL,
axis.minor.ticks = NULL,
axis.text = NULL,
axis.gap = NULL,
axis.ticks.length = NULL,
axis.minor.ticks.length = NULL,
axis.text.offset = NULL,
axis.text.orientation = NULL,
axis.text.check.overlap = NULL,
seq.label = NULL,
gene.label = NULL,
gene.label.segment = NULL,
feature.label = NULL,
feature.label.segment = NULL,
restriction.label = NULL,
restriction.label.segment = NULL,
seq.center.label = NULL,
seq.center.name = NULL,
seq.center.length = NULL,
legend.seq = NULL,
legend.seq.position = NULL,
legend.seq.direction = NULL,
legend.seq.background = NULL,
legend.seq.key = NULL,
legend.seq.key.size = NULL,
legend.seq.key.width = NULL,
legend.seq.key.height = NULL,
legend.seq.text = NULL,
legend.seq.text.position = NULL,
legend.seq.title = NULL,
legend.seq.title.position = NULL,
legend.seq.margin = NULL,
legend.seq.spacing = NULL,
legend.link = NULL,
legend.link.position = NULL,
legend.link.direction = NULL,
legend.link.background = NULL,
legend.link.key = NULL,
legend.link.key.size = NULL,
legend.link.key.width = NULL,
legend.link.key.height = NULL,
legend.link.text = NULL,
legend.link.text.position = NULL,
legend.link.title = NULL,
legend.link.title.position = NULL,
legend.link.margin = NULL,
legend.link.spacing = NULL,
legend.ribbon = NULL,
legend.ribbon.position = NULL,
legend.ribbon.direction = NULL,
legend.ribbon.background = NULL,
legend.ribbon.key = NULL,
legend.ribbon.key.size = NULL,
legend.ribbon.key.width = NULL,
legend.ribbon.key.height = NULL,
legend.ribbon.text = NULL,
legend.ribbon.text.position = NULL,
legend.ribbon.title = NULL,
legend.ribbon.title.position = NULL,
legend.ribbon.margin = NULL,
legend.ribbon.spacing = NULL,
legend.ribbon.ticks = NULL,
legend.ribbon.ticks.length = NULL,
legend.ribbon.axis.line = NULL,
legend.gene = NULL,
legend.gene.position = NULL,
legend.gene.direction = NULL,
legend.gene.background = NULL,
legend.gene.key = NULL,
legend.gene.key.size = NULL,
legend.gene.key.width = NULL,
legend.gene.key.height = NULL,
legend.gene.text = NULL,
legend.gene.text.position = NULL,
legend.gene.title = NULL,
legend.gene.title.position = NULL,
legend.gene.margin = NULL,
legend.gene.spacing = NULL,
legend.feature = NULL,
legend.feature.position = NULL,
legend.feature.direction = NULL,
legend.feature.background = NULL,
legend.feature.key = NULL,
legend.feature.key.size = NULL,
legend.feature.key.width = NULL,
legend.feature.key.height = NULL,
legend.feature.text = NULL,
legend.feature.text.position = NULL,
legend.feature.title = NULL,
legend.feature.title.position = NULL,
legend.feature.margin = NULL,
legend.feature.spacing = NULL,
legend.region = NULL,
legend.region.position = NULL,
legend.region.direction = NULL,
legend.region.background = NULL,
legend.region.key = NULL,
legend.region.key.size = NULL,
legend.region.key.width = NULL,
legend.region.key.height = NULL,
legend.region.text = NULL,
legend.region.text.position = NULL,
legend.region.title = NULL,
legend.region.title.position = NULL,
legend.region.margin = NULL,
legend.region.spacing = NULL,
...
)Arguments
- axis
NULLto show automatic sequence axes, orggplot2::element_blank()to hide the complete axis decoration.- axis.line, axis.ticks, axis.minor.ticks
Axis line elements.
- axis.text
Axis text element.
- axis.gap, axis.ticks.length, axis.minor.ticks.length, axis.text.offset
Scalar
grid::unit()objects controlling physical axis spacing. A negativeaxis.gapmoves circular ticks and labels inside the sequence ring; the plasmid preset uses this convention.- axis.text.orientation
One of
"horizontal","parallel","perpendicular", or a finite numeric angle.- axis.text.check.overlap
Whether overlapping axis labels are hidden.
- seq.label, gene.label, feature.label, restriction.label, seq.center.label, seq.center.name, seq.center.length
Text elements for sequence, gene, feature, restriction-site and circular centre labels.
- gene.label.segment, feature.label.segment, restriction.label.segment
Line elements for gene, feature and restriction-site leader lines.
- legend.seq, legend.ribbon, legend.gene, legend.feature, legend.region
NULLto show and inherit common settings, orggplot2::element_blank()to hide every guide for that role.- legend.seq.position, legend.ribbon.position, legend.gene.position, legend.feature.position, legend.region.position
Per-role guide positions.
- legend.seq.direction, legend.ribbon.direction, legend.gene.direction, legend.feature.direction, legend.region.direction
Per-role directions.
- legend.seq.background, legend.ribbon.background, legend.gene.background, legend.feature.background, legend.region.background
Per-role backgrounds.
- legend.seq.key, legend.ribbon.key, legend.gene.key, legend.feature.key, legend.region.key
Per-role key elements.
- legend.seq.key.size, legend.seq.key.width, legend.seq.key.height, legend.ribbon.key.size, legend.ribbon.key.width, legend.ribbon.key.height, legend.gene.key.size, legend.gene.key.width, legend.gene.key.height, legend.feature.key.size, legend.feature.key.width, legend.feature.key.height, legend.region.key.size, legend.region.key.width, legend.region.key.height
Per-role key dimensions.
- legend.seq.text, legend.ribbon.text, legend.gene.text, legend.feature.text, legend.region.text
Per-role text elements.
- legend.seq.text.position, legend.ribbon.text.position, legend.gene.text.position, legend.feature.text.position, legend.region.text.position
Per-role text positions.
- legend.seq.title, legend.ribbon.title, legend.gene.title, legend.feature.title, legend.region.title
Per-role title elements.
- legend.seq.title.position, legend.ribbon.title.position, legend.gene.title.position, legend.feature.title.position, legend.region.title.position
Per-role title positions.
- legend.seq.margin, legend.ribbon.margin, legend.gene.margin, legend.feature.margin, legend.region.margin
Per-role margins.
- legend.seq.spacing, legend.ribbon.spacing, legend.gene.spacing, legend.feature.spacing, legend.region.spacing
Per-role spacing.
- legend.link, legend.link.position, legend.link.direction, legend.link.background, legend.link.key, legend.link.key.size, legend.link.key.width, legend.link.key.height, legend.link.text, legend.link.text.position, legend.link.title, legend.link.title.position, legend.link.margin, legend.link.spacing
Point-link guide appearance; follows the same role-specific rules.
- legend.ribbon.ticks, legend.ribbon.axis.line
Ribbon colourbar lines.
- legend.ribbon.ticks.length
Ribbon colourbar tick length.
- ...
Standard ggplot2 theme arguments, including common text, plot and legend settings. Common legend settings also supply role inheritance. Removed underscore-style arguments produce a migration error.
Appearance settings
Ordinary text, panel, title and shared legend settings follow ggplot2.
Sequence-axis settings control automatic axis decoration, not genomic
break selection; use scale_seq_position_continuous() for breaks and labels.
Role text and leader elements style non-data annotation. Role legend
settings inherit common legend appearance, while scale and guide objects
continue to own palettes, breaks and ordering. Physical spacings require
scalar absolute grid::unit() values; axis.text.orientation is scalar.
The preset themes share this signature and provide appearance defaults.
Standard ggplot2 settings
Standard text, plot title/caption/tag, backgrounds, plot margins and common
legend settings remain available through ..., for example
theme_ggchord(text = element_text(size = 12)).
Only ggchord-specific settings appear as explicit formals for IDE argument
completion. An IDE that additionally expands upstream dots may still offer
upstream suggestions; this package controls its own function signature.
