Skip to contents
Chapters and reference

API reference · Section 2 of 4

Layer and coordinate compatibility

On this page

Check units, layers and parameters before changing coordinates. This table combines current Rd/source contracts with actual renders. Support describes an implementation, not every parameter combination. Layouts can use native bp/aa units; genes, primers and restriction layers retain nucleotide constraints.

Layers across six coordinate systems

Layer/reference Chord Collinear Single circular Radial Sankey Dotplot Conditions and boundaries
geom_seq() Supported Conditional Supported Conditional Conditional Unsupported Linear mode rejects explicit radius/curvature/ring
geom_seq_label() Supported Conditional Supported Conditional Conditional Unsupported No explicit radial label radius in linear mode
geom_gene() Conditional Conditional Conditional Conditional Conditional Unsupported Nucleotide units and source strands; use generic features for aa
geom_feature() Supported Supported Supported Conditional Conditional Unsupported Valid IDs, intervals and matching native units
geom_feature_plasmid() Supported Supported Supported Conditional Conditional Unsupported Generic feature preset; circular Position defaults need review when transferred
geom_gene_label() Supported Conditional Supported Conditional Conditional Unsupported Share the gene Position; radial/tangent become vertical/horizontal in linear mode
geom_feature_label() Supported Conditional Supported Conditional Conditional Unsupported Share the feature Position; radial/tangent become vertical/horizontal in linear mode
geom_gene_label_repel() Supported Conditional Supported Conditional Conditional Unsupported Linear rows reject external=FALSE; inspect hiding at target size
geom_feature_label_repel() Supported Conditional Supported Conditional Conditional Unsupported Linear rows reject external=FALSE; inspect fitting and hiding
geom_link_ribbon() Supported Conditional Unsupported Conditional Conditional Unsupported Linear adjacency follows display rows; segmented same-row ribbons are omitted and reported
geom_link_line() Supported Conditional Unsupported Conditional Conditional Unsupported Point coordinates required; explicit segmented same-row links unsupported
geom_seq_region() Supported Supported Supported Conditional Conditional Unsupported Valid source intervals, IDs and local side
geom_seq_scale() Unsupported Supported Unsupported Unsupported Conditional Unsupported Straight scale bars require collinear mode
geom_seq_break() Unsupported Conditional Unsupported Conditional Conditional Unsupported Collinear window boundaries required; does not edit source sequence
geom_seq_center_label() Conditional Unsupported Conditional Unsupported Unsupported Unsupported One displayed sequence; length uses its native bp/aa unit
geom_primer() Conditional Unsupported Conditional Unsupported Unsupported Unsupported One displayed DNA sequence and valid binding coordinates
geom_primer_label_repel() Conditional Unsupported Conditional Unsupported Unsupported Unsupported One displayed DNA sequence; share primer placement
geom_restriction_site() Conditional Unsupported Conditional Unsupported Unsupported Unsupported One displayed DNA sequence and actual computed cleavage sites
geom_track() Supported Supported Supported Conditional Conditional Unsupported Source-space Stat/Position; base matrix and estimation combinations
geom_track_bar() Supported Supported Supported Conditional Conditional Unsupported Count observations; use col for supplied values
geom_track_col() Supported Supported Supported Conditional Conditional Unsupported Explicit position_track; numeric heights and declared domains
geom_track_line() Supported Supported Supported Conditional Conditional Unsupported Explicit position_track; closure must be requested and missing samples respected
geom_track_tile() Supported Supported Supported Conditional Conditional Unsupported Explicit position_track; no numeric height required
geom_alignment_segment() Unsupported Unsupported Unsupported Unsupported Unsupported Identity HSP segments Dedicated two-axis geometry

23 representative layers were rendered in the three main modes using 69 explicitly synthetic geometry fixtures: 59 succeeded and 10 were rejected by contract, including automatic primer labels. Centre labels support bp/aa in single-sequence chord/circular views; primers and restriction layers require DNA. Help now clarifies these boundaries. This verifies mode boundaries, not all parameter combinations, biological recognition or devices. See the complete runtime record.

Understand conditional support

ggchord_validate_coord_contract() in R/coord-collinear.R explicitly checks circular parameters and conflicts involving automatic orientation or segments. Runtime validation also checks general data contracts and nucleotide-only restrictions. Current source files accompany the site under assets/source/; reference pages are generated from current roxygen/Rd.

A Position controls local placement; it cannot convert an unsupported layer into a different coordinate layer. Outside/inside means above/below in collinear mode and follows the outward/inward local normal in circular mode. Re-read the result when transferring settings. See four direction concepts for display direction versus biological strand.

Input units and script reuse

See installation for setup instructions and migration when updating existing scripts. Single circular mode requires one displayed sequence. Circular protein layout is a display choice, not a claim of molecular circularity. Project mixed bp/aa inputs first or plot them separately.

New coordinate systems

The Dotplot/Radial support matrix records the new contracts. Dotplot uses a dedicated identity HSP mark. Radial adapts the existing feature/Track frames with cyclic adjacency; circular-only layers, shared straight scales and branches are explicitly rejected. The current layer probes are recorded separately from the earlier three-view evidence.

Layer/reference Dotplot Radial
geom_alignment_segment() Supported identity HSP segment Unsupported

Static cross-panel composition

Fusion accepts registered Circular/Chord/Collinear/Sankey/Radial plots, nested Fusions and explicitly registered Cartesian character details. Eight named sides and explicit angle/box placements share the source-frame resolver. Each panel keeps its existing layer contract. Cross-panel interval fronts use one-based inclusive boundaries with continuous curve mapping; fully visible same-unit source intervals and unambiguous panel/instance routes are required. Generic Fusion scales affect cross-panel layers only. Dotplot, facets and implicit third-party coordinate adapters remain unregistered. Physical panels are remeasured at save time; this does not imply global collision avoidance or general font scaling.

Local aligned-character cells

Layer/reference Chord / Collinear / Circular / Dotplot / Radial / Sankey Ordinary Cartesian ggplot
geom_residue() Unsupported biological backbone projection Supported local character cells with identity/reverse position scales

The aligned-character workflow uses ordinary ggplot x/y coordinates. Source positions and alignment columns are separate fields. Final physical glyph measurement selects readable text or explicit tile/error behavior; it does not change source data or shrink fonts. Explicit source registration supports Fusion/magnify details. Optional source-backed CDS translation uses Biostrings and the existing CDS map; no alignment or missing phase is inferred. See CDS translation and character details.

Optional target-size policies

adapt_ggchord() supports individual Chord, Circular, Collinear, Sankey, Radial and Dotplot plots, and opted-in Fusion panels. It scales default theme styles and arranges native guides under explicit user constraints; no policy is applied by default. Facets, arbitrary custom grobs, outer Fusion allocations and a global label solver are outside this scope.

Magnification supports independent registered details with explicit per-row targets, eight named sides, nested leaf paths and free boxes. Deliberate overlap is opt-in; global avoidance is separate.

Fusion also supports Sankey/Radial, layered compositions and eight named sides or explicit boxes. Leaf-panel paths preserve independent sources, and deliberate overlaps export their paint order. Dotplot still requires independent axis registration. See Advanced boxes and nesting.

Search documentation

↑ ↓ select · Enter open · Esc close; or browse by task. API and functions