Chapters and reference
API reference · Section 3 of 4
Complete parameters and defaults atlas
On this page
Browse complete current parameters by purpose. Defaults come from actual formals and descriptions from matching Rd. NULL can resolve during layout. A choice vector may mean match.arg alternatives or multiple enabled options; read its description. Upstream reexports follow their own help.
Start with the function index. Examples compare important parameters; references define full signatures and forwarding. Expand functions as needed; upstream dots are not presented as separate ggchord APIs.
Coordinates and global views
coord_chord()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
rotation |
0 |
Type, units and accepted forms: see this API argument contract at right | Global counterclockwise layout rotation in degrees, default 0, measured from the positive x axis. This rotates the complete layout; it does not change the biological strand or sequence orientation. |
ratio |
1 |
Type, units and accepted forms: see this API argument contract at right | Fixed y/x aspect ratio, default 1. |
xlim |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional user limits. Explicit limits take priority over automatically fitted limits. |
ylim |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional user limits. Explicit limits take priority over automatically fitted limits. |
expand |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Expand coordinate limits, default FALSE. Automatic fitting already includes a small safety margin; set TRUE to request the additional ggplot2 coordinate expansion. |
clip |
"off" |
Type, units and accepted forms: see this API argument contract at right | Whether drawing is clipped to the panel, default “off”. |
fit |
c("labels", "geometry", "manual") |
Type, units and accepted forms: see this API argument contract at right | Fitting strategy: “labels” includes measured label boxes, “geometry” fits geometric elements only, and “manual” requires explicit xlim and ylim. |
coord_circular()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
rotation |
0 |
Type, units and accepted forms: see this API argument contract at right | Counterclockwise rotation in degrees from a 12-o’clock genomic origin. The default 0 keeps the origin at 12 o’clock; 90 places it at 9 o’clock, and -90 at 3 o’clock. |
direction |
c("clockwise", "counterclockwise") |
Type, units and accepted forms: see this API argument contract at right | Direction of increasing genomic coordinates. |
gap |
0 |
Type, units and accepted forms: see this API argument contract at right | Opening in degrees. Zero draws a closed circle. |
ratio |
1 |
Type, units and accepted forms: see this API argument contract at right | Fixed y/x aspect ratio, default 1. |
xlim |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional user limits. Explicit limits take priority over automatically fitted limits. |
ylim |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional user limits. Explicit limits take priority over automatically fitted limits. |
expand |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Expand coordinate limits, default FALSE. Automatic fitting already includes a small safety margin; set TRUE to request the additional ggplot2 coordinate expansion. |
clip |
"off" |
Type, units and accepted forms: see this API argument contract at right | Whether drawing is clipped to the panel, default “off”. |
fit |
c("labels", "geometry", "manual") |
Type, units and accepted forms: see this API argument contract at right | Fitting strategy: “labels” includes measured label boxes, “geometry” fits geometric elements only, and “manual” requires explicit xlim and ylim. |
coord_collinear()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
ratio |
1 |
Type, units and accepted forms: see this API argument contract at right | Fixed y/x aspect ratio, default 1. |
xlim |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional user limits. Explicit limits take priority over automatically fitted limits. |
ylim |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional user limits. Explicit limits take priority over automatically fitted limits. |
expand |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Expand coordinate limits, default FALSE. Automatic fitting already includes a small safety margin; set TRUE to request the additional ggplot2 coordinate expansion. |
clip |
"off" |
Type, units and accepted forms: see this API argument contract at right | Whether drawing is clipped to the panel, default “off”. |
fit |
c("labels", "geometry", "manual") |
Type, units and accepted forms: see this API argument contract at right | Fitting strategy: “labels” includes measured label boxes, “geometry” fits geometric elements only, and “manual” requires explicit xlim and ylim. |
align |
c("left", "center", "right") |
Type, units and accepted forms: see this API argument contract at right | Display alignment: “left” (default), “center”, or “right”. Applied to the full sequence or the interval supplied by anchor. |
anchor |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional anchor positions as a numeric vector named by accver, or a data frame with accver and either position or start/end. Every displayed sequence must have exactly one anchor. Missing and duplicate anchors are errors; multiple-copy targets must be selected explicitly before constructing the coordinate system. |
orientation |
c("manual", "auto") |
Type, units and accepted forms: see this API argument contract at right | “manual” (default) uses sequence directions supplied by geom_seq(). “auto” derives display directions from interval-link evidence and records support and unresolved cases. |
min_support |
0.1 |
Type, units and accepted forms: see this API argument contract at right | Minimum directional imbalance in [0, 1] for an automatic change. It is the absolute difference between forward and reverse support divided by their sum, default 0.1. A tie is always unresolved. |
segments |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional data frame with unique window accver, row_id and orientation (1 or -1). Every displayed accession must be declared. Each window has its own local coordinates and reversible source metadata. |
segment_gap |
100 |
Type, units and accepted forms: see this API argument contract at right | Positive display gap in native sequence units when segments is supplied, default 100. It never implies genomic continuity. |
seq_axis |
c("horizontal", "vertical") |
Type, units and accepted forms: see this API argument contract at right | “horizontal” (default) or “vertical”. Vertical mode projects sequence-local geometry onto upright columns and lays out text in its own readable orientation; it does not change source strands. |
coord_dotplot()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
x_seqs |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional unique accession vectors in axis order. Defaults to the query/subject accessions occurring in alignment layers, or all sequences when there are no alignments. Rows outside a selected axis set are omitted and recorded; self and repeated HSP rows are retained. |
y_seqs |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional unique accession vectors in axis order. Defaults to the query/subject accessions occurring in alignment layers, or all sequences when there are no alignments. Rows outside a selected axis set are omitted and recorded; self and repeated HSP rows are retained. |
x_orientation |
1 |
Type, units and accepted forms: see this API argument contract at right | Display direction: 1 or -1, either a scalar or a vector named by every selected accession. Input is unchanged. |
y_orientation |
1 |
Type, units and accepted forms: see this API argument contract at right | Display direction: 1 or -1, either a scalar or a vector named by every selected accession. Input is unchanged. |
gap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Nonnegative spacing in native sequence units between axis segments. NULL uses five percent of the longest sequence. |
ratio |
1 |
Type, units and accepted forms: see this API argument contract at right | Ratio of physical y units to physical x units, default 1. |
xlim |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional global concatenated position limits. These zoom the panel without changing exported HSP endpoints. |
ylim |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional global concatenated position limits. These zoom the panel without changing exported HSP endpoints. |
expand |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Expand panel limits, default FALSE. |
clip |
"on" |
Type, units and accepted forms: see this API argument contract at right | Panel clipping, “on” (default) or “off”. |
coord_radial_synteny()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
start_angle |
90 |
Type, units and accepted forms: see this API argument contract at right | Direction of the first outward spoke in degrees, counterclockwise from the positive x axis. Default 90 starts at noon. |
clockwise |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Logical, order subsequent spokes clockwise, default TRUE. |
inner_radius |
0.6 |
Type, units and accepted forms: see this API argument contract at right | Positive inner radius in layout units, default 0.6. The longest proportional spoke has length 2. The central hole is display spacing and does not remove any source positions. |
ratio |
1 |
Type, units and accepted forms: see this API argument contract at right | Fixed y/x aspect ratio, default 1. |
xlim |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional user limits. Explicit limits take priority over automatically fitted limits. |
ylim |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional user limits. Explicit limits take priority over automatically fitted limits. |
expand |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Expand coordinate limits, default FALSE. Automatic fitting already includes a small safety margin; set TRUE to request the additional ggplot2 coordinate expansion. |
clip |
"off" |
Type, units and accepted forms: see this API argument contract at right | Whether drawing is clipped to the panel, default “off”. |
fit |
c("labels", "geometry", "manual") |
Type, units and accepted forms: see this API argument contract at right | Fitting strategy: “labels” includes measured label boxes, “geometry” fits geometric elements only, and “manual” requires explicit xlim and ylim. |
nonadjacent_bulge |
0 |
Type, units and accepted forms: see this API argument contract at right | Non-negative outward lift at the midpoint of nonadjacent annular ribbons, in layout units (the longest proportional spoke has length 2). Default 0 retains the original path. The lift and its slope vanish at both endpoints. Adjacent ribbons and point links are unchanged. A positive lift also separates overlapping nonadjacent ribbon midpoints in the same channel, retaining their individual interval widths; this does not eliminate crossings forced by source endpoint order. Explicit geom_link_ribbon(link_ctrl_point = …) takes priority. |
coord_sankey()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
column_gap |
3 |
Type, units and accepted forms: see this API argument contract at right | Positive separation of the two backbones in layout units. |
self_links |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Show relationships whose query and subject entity are equal. |
ratio |
1 |
Type, units and accepted forms: see this API argument contract at right | Fixed y/x aspect ratio, default 1. |
xlim |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional user limits. Explicit limits take priority over automatically fitted limits. |
ylim |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional user limits. Explicit limits take priority over automatically fitted limits. |
expand |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Expand coordinate limits, default FALSE. Automatic fitting already includes a small safety margin; set TRUE to request the additional ggplot2 coordinate expansion. |
clip |
"off" |
Type, units and accepted forms: see this API argument contract at right | Whether drawing is clipped to the panel, default “off”. |
fit |
c("labels", "geometry", "manual") |
Type, units and accepted forms: see this API argument contract at right | Fitting strategy: “labels” includes measured label boxes, “geometry” fits geometric elements only, and “manual” requires explicit xlim and ylim. |
Geometry and labels
geom_alignment_segment()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 mapping and layer data. Data defaults to the constructor’s ribbon_data. Geometry roles are qaccver, saccver, qstart, qend, sstart, and send. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 mapping and layer data. Data defaults to the constructor’s ribbon_data. Geometry roles are qaccver, saccver, qstart, qend, sstart, and send. |
colour |
"#59636D" |
Type, units and accepted forms: see this API argument contract at right | Fixed styles. Mapped styles use link_colour, link_alpha, link_linewidth and link_linetype, with the corresponding scale_link functions. Explicit fixed styles win. |
alpha |
0.6 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles. Mapped styles use link_colour, link_alpha, link_linewidth and link_linetype, with the corresponding scale_link functions. Explicit fixed styles win. |
linewidth |
0.4 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles. Mapped styles use link_colour, link_alpha, link_linewidth and link_linetype, with the corresponding scale_link functions. Explicit fixed styles win. |
linetype |
1 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles. Mapped styles use link_colour, link_alpha, link_linewidth and link_linetype, with the corresponding scale_link functions. Explicit fixed styles win. |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Only “identity” is supported: data adjustment would change the alignment endpoints. |
show.legend |
NA |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
allow_repeated |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Allow explicitly identified source_hsp_id records to be displayed more than once. All participating layers must opt in. Rows without declared IDs are never deduplicated by their values. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional arguments passed to ggplot2’s segment geometry. |
geom_feature()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional aesthetic mapping. Role aesthetics such as accver, start, end and strand may rename input columns; ordinary visual mappings are evaluated after geometry is generated. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | data.frame with accver, start, end and strand; optional type, category and label. Factor start/end columns use their numeric labels, not their internal level codes. Coordinates must resolve to finite numbers. display_priority or logical prioritized_display. As an alternative to strand, directionality or direction may contain “forward”, “reverse”, “bidirectional”, or “none”. When omitted, uses the full constructor feature_data (or compatible gene_data). Other layers never remove records from this default input. |
shape |
"arrow" |
Type, units and accepted forms: see this API argument contract at right | Fixed feature geometry. An explicitly supplied shape takes precedence over aes(feature_shape = …): “arrow”, “compact_arrow”, “promoter_arrow”, “primer_arrow”, “marker”, “block”, “capped_line”, “primer_arc”, “chevron”, or “lollipop”. The default is “arrow”. Use aes(feature_shape = type) together with scale_feature_shape_manual() to map categories to geometry. |
width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric/vector/list controlling width in the shared feature geometry engine. In a circular feature-label composition, the base width responds to final label size within bounded limits. |
arrow_head_length |
0.04 |
Type, units and accepted forms: see this API argument contract at right | Arrow-head dimensions in the sequence-local frame, shared with geom_gene(). Values above one for arrow_head_width create a protruding block-arrow head. |
arrow_head_width |
1 |
Type, units and accepted forms: see this API argument contract at right | Arrow-head dimensions in the sequence-local frame, shared with geom_gene(). Values above one for arrow_head_width create a protruding block-arrow head. |
arrow_head_style |
c("shouldered", "flush", "triangle") |
Type, units and accepted forms: see this API argument contract at right | Arrowhead construction: “shouldered” keeps the requested protruding head, “flush” keeps it level with the body, and “triangle” draws a full triangular wedge. |
short_feature |
c("auto", "wedge", "block") |
Type, units and accepted forms: see this API argument contract at right | Fallback for arrows too short to hold their requested head: an automatically compressed directional glyph, a wedge, or a block. |
segment_boundaries |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Draw explicit internal marks carried by a segmented feature. Contiguous source-segment joins use dotted dividers; a non-solid segment-level line_style may override them, while a cleavage_arrows coordinate adds or merges a biological cut mark. These marks never create additional arrowheads. |
boundary_colour |
"#666666" |
Type, units and accepted forms: see this API argument contract at right | Appearance of internal segment joins. |
boundary_linewidth |
0.25 |
Type, units and accepted forms: see this API argument contract at right | Appearance of internal segment joins. |
boundary_linetype |
"22" |
Type, units and accepted forms: see this API argument contract at right | Appearance of internal segment joins. |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Feature placement. Use “identity”, “strand”, “plasmid”, position_strand(), position_plasmid(), or position_feature_stack(). |
show.legend |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional fixed polygon aesthetics. |
geom_feature_label()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer inputs. Map feature text with label. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer inputs. Map feature text with label. |
label_orientation |
c("feature", "horizontal", "radial", "tangent") |
Type, units and accepted forms: see this API argument contract at right | One of “feature”, “horizontal”, “radial”, or “tangent”. “feature” keeps both internal and adjacent labels tangent to the feature direction; compact labels move beside the feature. |
label_side |
c("outside", "inside", "auto") |
Type, units and accepted forms: see this API argument contract at right | One of “inside”, “outside”, or “auto”. |
label_overlap |
c("hide", "nudge", "allow") |
Type, units and accepted forms: see this API argument contract at right | Fixed-label collision policy. |
label_wrap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional character wrapping width. |
label_rotation |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric/vector/list. Label rotation angle, default 0 |
label_radial_offset |
0.04 |
Type, units and accepted forms: see this API argument contract at right | Optional numeric/vector/list. Radial offset of labels, default 0.04 |
label_circum_offset |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric/vector/list. Circumferential offset of labels, default 0 |
label_circum_limit |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional logical/vector/list. Whether to limit circumferential offset, default TRUE |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Feature Position used for the label anchor. In coord_collinear(), an omitted Position shares the matching feature layer’s lanes; an explicit Position changes only label anchors, leaving feature polygons in their own Position. If both inputs contain unique feature_id values, label inputs may be subsets or reordered; their accession, interval and strand must still agree. Without IDs, inheritance requires the same interval rows in order. Multiple matching geometry layers require an explicit label Position or unambiguous feature IDs. |
show.legend |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional text parameters. |
geom_feature_label_repel()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer inputs. Map feature text with label. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer inputs. Map feature text with label. |
label_layout |
c("feature", "radial", "auto", "callout") |
Type, units and accepted forms: see this API argument contract at right | One of “feature”, “radial”, “auto”, or “callout”. The default “feature” follows plasmid-map convention: text is tried inside first, then assigned to a fixed-radius internal track. All non-external text is laid out character by character along its selected track radius rather than rotated as one straight string. A light leader appears when tracks separate the feature and its label or a visible angular displacement could obscure ownership. Circular feature layouts retain direct leaders instead of multi-bend detours. Choose another mode for unrestricted external callouts. |
label_wrap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text fitting controls. label_fit = “shrink” explicitly uses internal-first placement without truncating the text. Text size is bounded by label_min_size; unresolved labels keep their requested font and use adjacent/external placement or hiding. Other fitting modes retain their existing behavior. |
label_fit |
c("wrap", "none", "ellipsis", "auto", "shrink") |
Type, units and accepted forms: see this API argument contract at right | Text fitting controls. label_fit = “shrink” explicitly uses internal-first placement without truncating the text. Text size is bounded by label_min_size; unresolved labels keep their requested font and use adjacent/external placement or hiding. Other fitting modes retain their existing behavior. |
label_max_lines |
2L |
Type, units and accepted forms: see this API argument contract at right | Text fitting controls. label_fit = “shrink” explicitly uses internal-first placement without truncating the text. Text size is bounded by label_min_size; unresolved labels keep their requested font and use adjacent/external placement or hiding. Other fitting modes retain their existing behavior. |
label_side |
c("outside", "inside", "auto") |
Type, units and accepted forms: see this API argument contract at right | One of “inside”, “outside”, or “auto”. |
max_overlaps |
Inf |
Type, units and accepted forms: see this API argument contract at right | Maximum unresolved overlaps. |
external |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Whether the staged feature layout may place a label outside the circular backbone after inside and adjacent placement fail. When FALSE, unresolved labels are hidden instead of pushing inward forever. External labels are rendered as rounded callouts using a lightened form of the feature’s resolved fill. When restriction-site labels coexist on a circular map, both retain their own layout semantics but register final boxes in one coordinate-owned exterior track region so they cannot occupy the same space. |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Feature Position used for the label anchor. In coord_collinear(), an omitted Position shares the matching feature layer’s lanes; an explicit Position changes only label anchors, leaving feature polygons in their own Position. If both inputs contain unique feature_id values, label inputs may be subsets or reordered; their accession, interval and strand must still agree. Without IDs, inheritance requires the same interval rows in order. Multiple matching geometry layers require an explicit label Position or unambiguous feature IDs. |
show.legend |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
label_min_size |
1.5 |
Type, units and accepted forms: see this API argument contract at right | Minimum text size in millimetres for explicit shrink, default 1.5. Must not exceed the requested text size. Original text, requested/final sizes and fitting reason are exported with the label. |
label_segment_overlap |
"fade" |
Type, units and accepted forms: see this API argument contract at right | Character, default “fade”. How portions of a leader line covered by another label are drawn: “fade” keeps them at reduced opacity, “clip” removes them, and “show” leaves the complete leader visible. This does not affect text wrapping, ellipsis or label hiding. |
label_segment_overlap_alpha |
0.18 |
Type, units and accepted forms: see this API argument contract at right | Numeric in [0, 1], default 0.18. Relative opacity applied only to covered leader-line portions when label_segment_overlap = “fade”. |
label_segment_linetype |
"auto" |
Type, units and accepted forms: see this API argument contract at right | Character or numeric, default “auto”. Leader-line linetype. “auto” draws solid lines, except for labels that were moved to the other side of their arc, which are drawn dashed. Any other valid ggplot2 linetype (e.g. “solid”, “dashed”, “dotted”, or a numeric dash pattern) is used for all leader lines. |
label_segment_layer |
c("below", "above") |
Type, units and accepted forms: see this API argument contract at right | Draw leaders “below” all data layers (default), or “above” at this label layer’s normal position. Text always stays at this layer’s position. Filled features can cover leaders drawn below; transparent features retain their normal transparency. |
label_repeat |
c("individual", "bracket") |
Type, units and accepted forms: see this API argument contract at right | “individual” (default) keeps one label per feature. “bracket” shares a counted label and an arc bracket for consecutive, non-overlapping short features with the same name, type, direction and resolved fill in one circular feature band. Source rows and individual arrows remain separate. Only supported with label_layout = “feature”. |
label_segment_colour |
"auto" |
Type, units and accepted forms: see this API argument contract at right | “auto” uses muted grey for leaders from a feature inside the sequence circle to a label outside it. Other leaders retain the theme colour. Explicit colours override both. A custom feature-label segment theme overrides the automatic palette. label_segment_linetype = “auto” uses dashed lines for those inside-to-outside attachments. Labels that stay inside retain their established leader style. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional text parameters. |
geom_feature_plasmid()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional aesthetic mapping. Role aesthetics such as accver, start, end and strand may rename input columns; ordinary visual mappings are evaluated after geometry is generated. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | data.frame with accver, start, end and strand; optional type, category and label. Factor start/end columns use their numeric labels, not their internal level codes. Coordinates must resolve to finite numbers. display_priority or logical prioritized_display. As an alternative to strand, directionality or direction may contain “forward”, “reverse”, “bidirectional”, or “none”. When omitted, uses the full constructor feature_data (or compatible gene_data). Other layers never remove records from this default input. |
shape |
"arrow" |
Type, units and accepted forms: see this API argument contract at right | Fixed feature geometry. An explicitly supplied shape takes precedence over aes(feature_shape = …): “arrow”, “compact_arrow”, “promoter_arrow”, “primer_arrow”, “marker”, “block”, “capped_line”, “primer_arc”, “chevron”, or “lollipop”. The default is “arrow”. Use aes(feature_shape = type) together with scale_feature_shape_manual() to map categories to geometry. |
width |
0.058 |
Type, units and accepted forms: see this API argument contract at right | Track width; the default matches the compact feature bands used by desktop plasmid editors. |
arrow_head_length |
0.068 |
Type, units and accepted forms: see this API argument contract at right | Arrow-head dimensions in the sequence-local frame, shared with geom_gene(). Values above one for arrow_head_width create a protruding block-arrow head. |
arrow_head_width |
1.42 |
Type, units and accepted forms: see this API argument contract at right | Arrow-head dimensions in the sequence-local frame, shared with geom_gene(). Values above one for arrow_head_width create a protruding block-arrow head. |
arrow_head_style |
"shouldered" |
Type, units and accepted forms: see this API argument contract at right | Arrowhead construction: “shouldered” keeps the requested protruding head, “flush” keeps it level with the body, and “triangle” draws a full triangular wedge. |
short_feature |
"auto" |
Type, units and accepted forms: see this API argument contract at right | Fallback for arrows too short to hold their requested head: an automatically compressed directional glyph, a wedge, or a block. |
segment_boundaries |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Draw explicit internal marks carried by a segmented feature. Contiguous source-segment joins use dotted dividers; a non-solid segment-level line_style may override them, while a cleavage_arrows coordinate adds or merges a biological cut mark. These marks never create additional arrowheads. |
boundary_colour |
"#666666" |
Type, units and accepted forms: see this API argument contract at right | Appearance of internal segment joins. |
boundary_linewidth |
0.25 |
Type, units and accepted forms: see this API argument contract at right | Appearance of internal segment joins. |
boundary_linetype |
"22" |
Type, units and accepted forms: see this API argument contract at right | Appearance of internal segment joins. |
position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Feature position. NULL (the default) automatically stacks overlapping features on compact lanes inside the plasmid backbone. Reuse the same explicit position_feature_stack() object for a separate label layer so polygons and labels share their lanes. Optional numeric display_priority (larger first) or logical prioritized_display can override the default longest-first ordering for overlapping features. |
show.legend |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional fixed polygon aesthetics. |
geom_gene()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Default NULL (uses pre-computed data) |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional layer table or function, overriding constructor data. With unified feature_data, the default selects explicitly classified gene/CDS records; see ggchord(). Legacy gene_data retains all rows. |
width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric/vector/list. Width of gene arrows, default 0.05 |
arrow_head_length |
0.04 |
Type, units and accepted forms: see this API argument contract at right | Shared arrow-head dimensions in the sequence-local frame. |
arrow_head_width |
1 |
Type, units and accepted forms: see this API argument contract at right | Shared arrow-head dimensions in the sequence-local frame. |
arrow_head_style |
c("shouldered", "flush", "triangle") |
Type, units and accepted forms: see this API argument contract at right | Arrowhead construction: shouldered, flush, or a full triangular wedge. |
short_feature |
c("auto", "wedge", "block") |
Type, units and accepted forms: see this API argument contract at right | Fallback for arrows too short to hold their requested head: automatic wedge/block selection, a wedge, or a block. |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Feature placement. Use “identity”, “strand”, “plasmid”, position_strand(), position_plasmid(), or position_feature_stack(). |
show.legend |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional arguments passed to geom_polygon() |
geom_gene_label()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Default NULL (uses pre-computed data) |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional layer table or function. Default data follows the gene/CDS selection described in ggchord(). |
label_orientation |
"horizontal" |
Type, units and accepted forms: see this API argument contract at right | Character, default “horizontal”. Text orientation relative to each sequence path: “radial”, “tangent”, or “horizontal”. |
label_side |
"outside" |
Type, units and accepted forms: see this API argument contract at right | Character, default “outside”. Place labels outside the chord, use the strand-based “auto” side, or force “inside” placement. |
label_overlap |
"hide" |
Type, units and accepted forms: see this API argument contract at right | Character, default “hide”. Fixed-label collision policy: omit later conflicting labels (“hide”), apply the small position adjustment (“nudge”), or keep all requested positions (“allow”). Input row order therefore provides a simple way to prioritize labels in “hide” mode. |
label_rotation |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric/vector/list. Label rotation angle, default 0 |
label_radial_offset |
0.04 |
Type, units and accepted forms: see this API argument contract at right | Optional numeric/vector/list. Radial offset of labels, default 0.04 |
label_circum_offset |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric/vector/list. Circumferential offset of labels, default 0 |
label_circum_limit |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional logical/vector/list. Whether to limit circumferential offset, default TRUE |
label_wrap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Numeric or NULL, default NULL. When set, long gene annotations are wrapped at this many characters (e.g. 15), which makes the labels narrower and less prone to overlap. |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Position adjustment. Supply the same position_feature_stack() used by a gene/feature layer when labels are drawn from separate data or without a geometry layer. In coord_collinear(), labels without an explicit Position share a matching geometry layer’s lanes; explicit label Positions do not move the geometry layer. Unique feature_id columns allow label subsets and reordered labels when their accession, interval and strand agree with the geometry input. Multiple matching geometry layers require an explicit label Position or unambiguous feature IDs. |
show.legend |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional arguments passed to geom_text() |
geom_gene_label_repel()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Default NULL (uses pre-computed data) |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional layer table or function. Default data follows the gene/CDS selection described in ggchord(). |
label_layout |
"radial" |
Type, units and accepted forms: see this API argument contract at right | Character, default “radial”. Label layout: “radial” arranges horizontal external labels along sequence-relative contours, with straight normal leaders or a short normal departure followed by a long connector when displaced; “auto” uses shared vertical columns on the left/right and radial placement elsewhere; “arc” rotates text along the sequence tangent. The former “aligned” mode has been removed; use “auto” for side columns. |
label_wrap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Numeric or NULL, default NULL. When set, long gene annotations are wrapped at this many characters (e.g. 15), overriding label_fit. |
label_fit |
"wrap" |
Type, units and accepted forms: see this API argument contract at right | Character, default “wrap”. How labels whose initial boxes are crowded or unusually wide are fitted before deterministic layout: “wrap” preserves the complete annotation over multiple lines, “ellipsis” uses a single shortened line, “auto” wraps and adds an ellipsis only if text exceeds label_max_lines, and “none” disables adaptive fitting. Explicit “shrink” uses internal-first feature placement and reduces the complete text only as far as label_min_size. Labels that still cannot fit use the existing adjacent/external placement or hiding policy, at their requested size. This choice uses feature placement rather than the external layout selected by label_layout; other fitting modes are unchanged. |
label_max_lines |
2L |
Type, units and accepted forms: see this API argument contract at right | Positive integer, default 2. Maximum number of lines used by adaptive “wrap” or “auto” fitting. |
label_side |
"outside" |
Type, units and accepted forms: see this API argument contract at right | Character, default “outside”. Which side of the arc the labels sit on. “auto” keeps the strand-based placement (same as before); “outside” moves labels that would be inside the chord (where they can overlap the ribbons) to the outside of their arc; “inside” does the opposite. Labels moved to the other side are connected with a dashed leader line (see label_segment_linetype). |
max_overlaps |
Inf |
Type, units and accepted forms: see this API argument contract at right | Numeric, default Inf. Hide labels that still overlap more than this many other labels after repulsion (ggrepel-style decluttering). Use a finite value to clean up crowded plots. |
label_segment_overlap |
"fade" |
Type, units and accepted forms: see this API argument contract at right | Character, default “fade”. How portions of a leader line covered by another label are drawn: “fade” keeps them at reduced opacity, “clip” removes them, and “show” leaves the complete leader visible. This does not affect text wrapping, ellipsis or label hiding. |
label_segment_overlap_alpha |
0.18 |
Type, units and accepted forms: see this API argument contract at right | Numeric in [0, 1], default 0.18. Relative opacity applied only to covered leader-line portions when label_segment_overlap = “fade”. |
label_segment_linetype |
"auto" |
Type, units and accepted forms: see this API argument contract at right | Character or numeric, default “auto”. Leader-line linetype. “auto” draws solid lines, except for labels that were moved to the other side of their arc, which are drawn dashed. Any other valid ggplot2 linetype (e.g. “solid”, “dashed”, “dotted”, or a numeric dash pattern) is used for all leader lines. |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Position adjustment. Supply the same position_feature_stack() used by a gene/feature layer when labels are drawn from separate data or without a geometry layer. |
show.legend |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
label_min_size |
1.5 |
Type, units and accepted forms: see this API argument contract at right | Minimum text size in millimetres for explicit label_fit = “shrink”, default 1.5. It must not exceed the requested text size. Source text, requested/final size and fitting reason are retained in exported label geometry. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional text styles and drawing options. Automatic layouts own rotation, offsets, orientation and overlap policy; use geom_gene_label() for manual label_rotation, label_radial_offset, label_circum_offset, label_circum_limit, label_orientation or label_overlap. These manual controls are rejected here. |
geom_link_line()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 mapping and layer data, including data functions. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 mapping and layer data, including data functions. |
link_type |
c("curve", "straight") |
Type, units and accepted forms: see this API argument contract at right | Either “curve” (default) or “straight”. |
link_gap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Explicit endpoint spacing. With the default link_avoid = “none”, NULL uses a fixed spacing of 0.035. Set link_avoid to “smooth” or “uniform” to opt in to entity-aware endpoint spacing. |
link_ctrl_point |
NULL |
Type, units and accepted forms: see this API argument contract at right | Bezier control points: two numbers, four numbers, or a list per input row. |
link_avoid |
c("none", "smooth", "uniform") |
Type, units and accepted forms: see this API argument contract at right | One of “none” (default), “smooth”, or “uniform”. Explicit gap takes precedence. |
link_branch |
c("none", "query", "subject") |
Type, units and accepted forms: see this API argument contract at right | Share equal query or subject endpoints: “none”, “query”, “subject”. |
link_branch_fraction |
0.15 |
Type, units and accepted forms: see this API argument contract at right | Shared length relative to the shortest member, in (0, 0.5]. |
arrow |
NULL |
Type, units and accepted forms: see this API argument contract at right | A grid arrow specification, or NULL. |
colour |
"#59636D" |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; mappings use link_* aesthetics. An explicitly supplied fixed value takes precedence over the matching mapping. Omit the fixed argument to retain a mapped style, including an inherited mapping when inherit.aes = TRUE. |
alpha |
0.6 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; mappings use link_* aesthetics. An explicitly supplied fixed value takes precedence over the matching mapping. Omit the fixed argument to retain a mapped style, including an inherited mapping when inherit.aes = TRUE. |
linewidth |
0.4 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; mappings use link_* aesthetics. An explicitly supplied fixed value takes precedence over the matching mapping. Omit the fixed argument to retain a mapped style, including an inherited mapping when inherit.aes = TRUE. |
linetype |
1 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; mappings use link_* aesthetics. An explicitly supplied fixed value takes precedence over the matching mapping. Omit the fixed argument to retain a mapped style, including an inherited mapping when inherit.aes = TRUE. |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
show.legend |
NA |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
between |
NULL |
Type, units and accepted forms: see this API argument contract at right | Two display-instance names or declared-order indices. |
allow_repeated |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Allow repeated display of an explicitly declared source_hsp_id. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional path parameters. |
geom_link_ribbon()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Default NULL (uses pre-computed data) |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Default NULL (retrieved automatically from the layout) |
link_ctrl_point |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional vector/list of Bezier edge controls. Two numbers specify one shared control; four numbers specify controls for the two ribbon edges. A per-row list may contain pairs of coordinate vectors. NULL uses the origin c(0, 0) in chord layouts and derives controls from the sequence endpoints in collinear layouts. In Radial layouts NULL uses annular curves; explicit controls use final Cartesian layout units, one point for each edge. Use a separate layer to adjust nonadjacent links without changing adjacent curves. This controls the middle of the path; link_gap only controls clearance at the sequence endpoints. With shared branches, controls shape the far ends while the junction follows the shared trunk. |
link_gap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric/vector controlling spacing between sequences and ribbon endpoints. With the default link_avoid = “uniform”, NULL uses one obstacle-aware clearance across each endpoint. Use “smooth” for clearance that changes only next to geom_gene() and geom_feature() polygons, or “none” for fixed spacing 0.035. Text and leader lines are ignored. Supplying a number disables the automatic rule and uses that exact spacing. Linear layouts reduce automatic baseline clearance to fit narrow channels; an explicit gap or feature clearance that cannot fit raises an error. |
link_avoid |
c("uniform", "none", "smooth") |
Type, units and accepted forms: see this API argument contract at right | One of “uniform” (default), “none”, or “smooth”. Smooth avoidance changes clearance locally; uniform avoidance uses one clearance across an endpoint. |
link_branch |
c("none", "query", "subject") |
Type, units and accepted forms: see this API argument contract at right | Share equal query or subject endpoints: “none”, “query”, “subject”. |
link_branch_fraction |
0.15 |
Type, units and accepted forms: see this API argument contract at right | Shared length relative to the shortest member, in (0, 0.5]. |
fill |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional fixed ribbon fill. NULL uses the default Identity fill. |
alpha |
0.42 |
Type, units and accepted forms: see this API argument contract at right | Standard fixed ribbon styles. Explicit values take precedence over matching mappings; omitted defaults do not suppress user mappings. For example, omit alpha when mapping ribbon_alpha. |
colour |
"#59636D" |
Type, units and accepted forms: see this API argument contract at right | Standard fixed ribbon styles. Explicit values take precedence over matching mappings; omitted defaults do not suppress user mappings. For example, omit alpha when mapping ribbon_alpha. |
linewidth |
0.08 |
Type, units and accepted forms: see this API argument contract at right | Standard fixed ribbon styles. Explicit values take precedence over matching mappings; omitted defaults do not suppress user mappings. For example, omit alpha when mapping ribbon_alpha. |
linetype |
NULL |
Type, units and accepted forms: see this API argument contract at right | Fixed outline line type. The default NULL uses solid outlines in Chord and Sankey views. coord_collinear() uses dashed outlines for non-adjacent displayed rows, with widths set by nonadjacent_linewidth; adjacent rows stay solid. This row convention follows final display order, independently of alignment direction. coord_radial_synteny() also uses dashed nonadjacent outlines, with adjacency defined cyclically (including first/last); nonadjacent_linewidth uses the same width convention as Collinear. Explicit fixed styles or aes(ribbon_linetype = …) (also aes(linetype = …)) replace the automatic styles. Use a matching scale for data mappings; automatic styles do not train a linetype scale. Global line-type mappings are used when inherit.aes = TRUE. |
adjacent_only |
NULL |
Type, units and accepted forms: see this API argument contract at right | Whether only neighbouring sequences are connected. NULL uses TRUE in coord_collinear() and FALSE in coord_chord(). Set FALSE to retain cross-track ribbons. Chord neighbours include the first/last sequence pair. |
pairs |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional data frame with qaccver and saccver selecting unordered comparison pairs. With adjacent_only = NULL, explicit pairs take precedence over the coordinate default. Omitted rows are reported by export_ggchord_layout(). |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
show.legend |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
nonadjacent_linewidth |
0.4 |
Type, units and accepted forms: see this API argument contract at right | Fixed outline width for non-adjacent displayed rows in coord_collinear() or nonadjacent spokes in coord_radial_synteny(), default 0.4 mm. These ribbons use dashed outlines by default. Zero uses the layer’s ordinary linewidth for every ribbon. This changes width independently of line type. An explicit aes(linewidth = …) controls widths instead of this fixed default. |
between |
NULL |
Type, units and accepted forms: see this API argument contract at right | Two display-instance names or declared-order indices for a unique route. |
allow_repeated |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Explicitly allow a declared source_hsp_id in more than one displayed relation. |
tip |
c("none", "subject") |
Type, units and accepted forms: see this API argument contract at right | Full interval fronts (none, default), or an optional subject taper. The shoulder retains the translated target endpoint span at 88 percent of the channel. The tip is a decorative front-midpoint marker, not a single matched base or biological transfer direction. Degenerate fronts fall back to the full front with a warning. Source intervals are unchanged. |
gradient |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Opt into endpoint sequence-colour interpolation; default FALSE. Explicit fill, mapping and scales still take priority. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional arguments passed to geom_polygon() |
geom_primer()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer inputs. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer inputs. |
side |
c("between", "outside", "inside") |
Type, units and accepted forms: see this API argument contract at right | Backbone lane used by the primer arc. “between” uses the backbone centre line; “outside” and “inside” use arc_offset. |
arc_offset |
0.045 |
Type, units and accepted forms: see this API argument contract at right | Distance from the backbone centre when side is “outside” or “inside”. |
arc_linewidth |
0.026 |
Type, units and accepted forms: see this API argument contract at right | Radial width of the primer arc. |
colour |
"#A020F0" |
Type, units and accepted forms: see this API argument contract at right | Primer arc colour. |
position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer arguments. |
show.legend |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional parameters passed to geom_feature(). |
geom_primer_label_repel()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer inputs. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer inputs. |
side |
c("outside", "inside") |
Type, units and accepted forms: see this API argument contract at right | Side of the backbone on which the primer callout is arranged. “inside” retains the inner label layout, including when exterior restriction or feature labels share the map. The default is “outside”. |
show_location |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Include the binding range in the label. |
colour |
"#A020F0" |
Type, units and accepted forms: see this API argument contract at right | Primer arc colour. |
max_overlaps |
Inf |
Type, units and accepted forms: see this API argument contract at right | Maximum unresolved overlaps. |
position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer arguments. |
show.legend |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional parameters passed to geom_feature(). |
geom_residue()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer mapping and data. Required aesthetics are x, y and label; ordinary colour, fill, alpha, size, family and fontface mappings and scales are supported. Explicit size is in mm; when omitted, glyphs fit cells uniformly with a minimum of 3 mm. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer mapping and data. Required aesthetics are x, y and label; ordinary colour, fill, alpha, size, family and fontface mappings and scales are supported. Explicit size is in mm; when omitted, glyphs fit cells uniformly with a minimum of 3 mm. |
overflow |
c("tile", "error") |
Type, units and accepted forms: see this API argument contract at right | “tile” (default) or “error” when letters do not fit. |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
show.legend |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
line_width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional positive integer number of columns per displayed line; NULL keeps one line. Segments start at the smallest displayed x value; gaps consume columns and sequences share boundaries. Row labels retain original column ranges; x shows within-line columns. Display changes preserve input and source coordinates. Each registered Fusion selection must fit within one displayed line; split selections spanning lines into explicit source intervals. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Fixed text/cell aesthetics and na.rm, passed to the layer. |
geom_restriction_site()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer inputs. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer inputs. |
label |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Draw labels. |
label_style |
c("enzyme_position", "enzyme", "position") |
Type, units and accepted forms: see this API argument contract at right | Label enzyme and position, enzyme only, or position only. |
label_order |
c("auto", "enzyme_position", "position_enzyme") |
Type, units and accepted forms: see this API argument contract at right | Automatic mirrored label order, enzyme first, or position first. |
label_side |
c("outside", "inside", "auto") |
Type, units and accepted forms: see this API argument contract at right | Draw labels outside, inside, or automatically. |
leader |
c("radial", "elbow", "straight") |
Type, units and accepted forms: see this API argument contract at right | Leader routing style. The default “radial” measures actual text boxes, separates site anchors from final radial label positions, and routes either a direct connector or an independent radial stub plus fan segment. All enzyme-facing text edges follow one close circular contour in genomic order. Dense lateral clusters use evenly spaced contour fans, while sparse clusters retain their natural angular positions. The former “trunk” alias was removed in v0.16.1; use “radial”. “straight” connects the tick tip directly to the final label edge, without detours around the sequence or other leaders. “elbow” uses one bend, starting with a local-normal departure where possible. Label positions and grouping are shared by all routing styles. |
min_label_gap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Minimum genomic fraction between label slots. NULL derives a compact device-aware default from the rendered labels. |
tick_length |
0.04 |
Type, units and accepted forms: see this API argument contract at right | Local-normal distances. |
label_offset |
0.18 |
Type, units and accepted forms: see this API argument contract at right | Local-normal distances. |
colour |
"#202020" |
Type, units and accepted forms: see this API argument contract at right | Fixed appearance. With the default fontface = NULL, enzyme names are bold only when that enzyme cuts once in the supplied sequence; coordinates remain regular. An explicit fontface disables this automatic distinction. |
linewidth |
0.28 |
Type, units and accepted forms: see this API argument contract at right | Fixed appearance. With the default fontface = NULL, enzyme names are bold only when that enzyme cuts once in the supplied sequence; coordinates remain regular. An explicit fontface disables this automatic distinction. |
label_size |
3.2 |
Type, units and accepted forms: see this API argument contract at right | Fixed appearance. With the default fontface = NULL, enzyme names are bold only when that enzyme cuts once in the supplied sequence; coordinates remain regular. An explicit fontface disables this automatic distinction. |
fontface |
NULL |
Type, units and accepted forms: see this API argument contract at right | Fixed appearance. With the default fontface = NULL, enzyme names are bold only when that enzyme cuts once in the supplied sequence; coordinates remain regular. An explicit fontface disables this automatic distinction. |
family |
NULL |
Type, units and accepted forms: see this API argument contract at right | Fixed appearance. With the default fontface = NULL, enzyme names are bold only when that enzyme cuts once in the supplied sequence; coordinates remain regular. An explicit fontface disables this automatic distinction. |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Standard layer arguments. |
show.legend |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Extra geom parameters. |
geom_seq()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Default NULL (uses pre-computed data) |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Default NULL (retrieved automatically from the layout) |
seq_order |
NULL |
Type, units and accepted forms: see this API argument contract at right | Source IDs in display order. Repeats create display instances; use names such as c(A_high=‘A’, B=‘B’, A_low=‘A’) for stable instance IDs. Repeated-entity HSPs require a unique between route on each link layer. |
seq_orientation |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric (1 or -1). Sequence orientation, default 1 |
seq_gap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric. Gap proportion between sequences, default 0.03 in chord coordinates. A named vector can set the gap after each sequence; omitted IDs use the coordinate default. In coord_collinear(), a positive distance between consecutive backbones as a proportion of the longest backbone’s width, default 0.3. The final sequence’s gap is unused in linear layouts. Segmented linear displays measure it against the longest display row; windows in one row must request the same gap, and only gaps between rows affect vertical placement. |
seq_radius |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric (> 0). Sequence arc radius, default 1.0 |
seq_curvature |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric. Signed arc bow (0=straight, 1=standard arc, negative=opposite bow), default 1.0. Finite positive and negative values are accepted without clipping; magnitudes above 1 amplify the bow. |
seq_style |
c("auto", "single", "double", "band") |
Type, units and accepted forms: see this API argument contract at right | Backbone geometry. “auto” uses a double backbone in coord_circular() and a single backbone in coord_chord(). |
seq_backbone_gap |
0.025 |
Type, units and accepted forms: see this API argument contract at right | Gap between double backbone lines. |
seq_backbone_width |
0.035 |
Type, units and accepted forms: see this API argument contract at right | Width of a band backbone. |
linewidth |
0.9 |
Type, units and accepted forms: see this API argument contract at right | Arc line width, default 0.9 |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
show.legend |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
length_mode |
c("proportional", "equal") |
Type, units and accepted forms: see this API argument contract at right | “proportional” (default) retains source-length ratios; “equal” gives each displayed sequence the same angular allocation or linear span without modifying source lengths. Shared absolute scale bars are unavailable in multi-sequence equal mode; local axes retain source units. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional fixed path aesthetics. colour (or color) sets seq_colour. Explicit fixed values take precedence over matching mappings; omit fixed arguments to retain mapped styles. |
geom_seq_break()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer mapping and sequence data. By default, use the plot’s sequence table. Truncation is read from .truncated_left/.truncated_right, with source interval and length metadata as fallback when available. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer mapping and sequence data. By default, use the plot’s sequence table. Truncation is read from .truncated_left/.truncated_right, with source interval and length metadata as fallback when available. |
break_width |
0.02 |
Type, units and accepted forms: see this API argument contract at right | Width and height of the complete break mark in linear layout units. These are layout distances, not millimetres. |
break_height |
0.04 |
Type, units and accepted forms: see this API argument contract at right | Width and height of the complete break mark in linear layout units. These are layout distances, not millimetres. |
linewidth |
0.4 |
Type, units and accepted forms: see this API argument contract at right | Fixed line appearance. Ordinary visual aesthetics can also be mapped and controlled by their ggplot2 scales. |
colour |
"#3D4348" |
Type, units and accepted forms: see this API argument contract at right | Fixed line appearance. Ordinary visual aesthetics can also be mapped and controlled by their ggplot2 scales. |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
show.legend |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional parameters passed to ggplot2::geom_path(). |
geom_seq_center_label()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer inputs. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer inputs. |
name |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Show the sequence name. A character value overrides the name. |
length |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Show the formatted sequence length. |
separator |
"\n" |
Type, units and accepted forms: see this API argument contract at right | Separator between name and length. |
name_style |
list() |
Type, units and accepted forms: see this API argument contract at right | Named lists of fixed text-style overrides for the name and length grobs. Supported fields are colour, size, family, fontface, and lineheight. |
length_style |
list() |
Type, units and accepted forms: see this API argument contract at right | Named lists of fixed text-style overrides for the name and length grobs. Supported fields are colour, size, family, fontface, and lineheight. |
show.legend |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional arguments passed to geom_text() |
geom_seq_label()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Default NULL (uses pre-computed data) |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Default NULL (retrieved automatically from the layout) |
seq_label_radius |
1 |
Type, units and accepted forms: see this API argument contract at right | Optional numeric/vector. Radial position of the labels as a multiplier of the sequence arc radius: 1 is on the arc, > 1 places the label outside (away from the chord center) and < 1 places it inside, default 1 Explicit values are incompatible with coord_collinear(), which places sequence labels beside the left endpoint of each horizontal track. |
seq_label_rotation |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric/vector. Additional label rotation (degrees) on top of the arc-aligned orientation, default NULL (0). Ignored when seq_label_orientation = “horizontal”. |
labels |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional character vector. Override the label texts (defaults to the sequence labels from geom_seq() or the sequence IDs) |
seq_label_orientation |
c("arc", "horizontal") |
Type, units and accepted forms: see this API argument contract at right | Character, default “arc”. Label text orientation: “arc” rotates the text along the sequence arc (and keeps it readable), “horizontal” draws every label horizontally, extending away from the chord center. |
seq_label_hjust |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric/vector. Horizontal justification of the labels, default NULL. The default arc orientation uses -0.2 so the text sits just inside the sequence; with seq_label_orientation = “horizontal” the justification is chosen automatically so the text extends away from the chord center. |
seq_label_vjust |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric/vector. Vertical justification of the labels, default NULL (0.5). |
check_overlap |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical, default FALSE. When TRUE, labels that would overlap a previously drawn label are skipped (ggplot2’s geom_text() option). |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
show.legend |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional arguments passed to geom_text() |
geom_seq_region()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Default NULL (uses pre-computed data) |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | data.frame with at least accver, start, end; optional label, category and color. Factor start/end columns use their numeric labels, not level codes. |
fill |
"#F59E0B" |
Type, units and accepted forms: see this API argument contract at right | Character. Default fill colour for regions, default “#F59E0B”. |
colour |
"#B45309" |
Type, units and accepted forms: see this API argument contract at right | Outline colour, default “#B45309”. |
alpha |
0.25 |
Type, units and accepted forms: see this API argument contract at right | Numeric (0-1). Region alpha, default 0.25. |
region_width |
0.08 |
Type, units and accepted forms: see this API argument contract at right | Numeric. Band width in chord radius units, default 0.08. |
region_offset |
0 |
Type, units and accepted forms: see this API argument contract at right | Numeric. Radial offset from the sequence arc, default 0. |
region_side |
c("inside", "outside", "auto") |
Type, units and accepted forms: see this API argument contract at right | Character. “inside”, “outside” or “auto”; “auto” places regions inside the chord when possible. |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
show.legend |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional arguments passed to geom_polygon() |
geom_seq_scale()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer inputs. Optional scale_length maps one positive integer length per bar, in the sequence unit; label supplies its text. Multiple bars require explicit x and y layout positions in data (or their role mappings), to avoid accidental overprinting. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer inputs. Optional scale_length maps one positive integer length per bar, in the sequence unit; label supplies its text. Multiple bars require explicit x and y layout positions in data (or their role mappings), to avoid accidental overprinting. |
length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional fixed positive integer length in the sequence unit. Cannot be combined with a scale_length mapping. NULL uses input lengths or an automatic reference length. |
label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional fixed character label, or a function receiving the chosen lengths. NULL uses input labels or formatted bp/aa text. |
location |
c("bottomleft", "bottomright", "topleft", "topright") |
Type, units and accepted forms: see this API argument contract at right | Corner of the sequence envelope used for automatic placement. |
offset |
grid::unit(c(0, 6), "mm") |
Type, units and accepted forms: see this API argument contract at right | Two non-negative distances, horizontal then vertical. Absolute grid units are supported; plain numeric values are layout-unit distances. The default is 0 mm horizontally and 6 mm vertically. |
tick_height |
grid::unit(1.5, "mm") |
Type, units and accepted forms: see this API argument contract at right | Non-negative absolute grid units or layout-unit numbers for the end ticks and space between the bar and caption. Physical conversion uses the current render context when available; device-free builds retain an explicitly estimated measurement status. |
label_gap |
grid::unit(1.5, "mm") |
Type, units and accepted forms: see this API argument contract at right | Non-negative absolute grid units or layout-unit numbers for the end ticks and space between the bar and caption. Physical conversion uses the current render context when available; device-free builds retain an explicitly estimated measurement status. |
linewidth |
0.4 |
Type, units and accepted forms: see this API argument contract at right | Fixed line colour/width and text size. Text size follows ordinary ggplot2 millimetres. These may also use normal mappings and scales when not supplied as fixed arguments. |
colour |
"#3D4348" |
Type, units and accepted forms: see this API argument contract at right | Fixed line colour/width and text size. Text size follows ordinary ggplot2 millimetres. These may also use normal mappings and scales when not supplied as fixed arguments. |
size |
3 |
Type, units and accepted forms: see this API argument contract at right | Fixed line colour/width and text size. Text size follows ordinary ggplot2 millimetres. These may also use normal mappings and scales when not supplied as fixed arguments. |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
show.legend |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional fixed aesthetics passed to ggplot2::layer(). |
geom_track()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer input. Supply accver and source positions through x/pos, or interval start/end. Map y/track_value for identity values. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer input. Supply accver and source positions through x/pos, or interval start/end. Map y/track_value for identity values. |
geom |
"point" |
Type, units and accepted forms: see this API argument contract at right | Native geometry/statistic names. bar defaults to count; col and other geoms default to identity. |
stat |
NULL |
Type, units and accepted forms: see this API argument contract at right | Native geometry/statistic names. bar defaults to count; col and other geoms default to identity. |
track |
NULL |
Type, units and accepted forms: see this API argument contract at right | A physical position_track() declaration. |
position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Data position such as identity, stack, dodge. The legacy position=position_track(…) spelling still declares the physical band. |
bounds |
c("error", "clip") |
Type, units and accepted forms: see this API argument contract at right | Coordinate error/clip policy. |
baseline |
0 |
Type, units and accepted forms: see this API argument contract at right | Numeric identity-column baseline. Nonzero baselines require position=‘identity’ so stacking does not change their meaning. |
show.legend |
NA |
Type, units and accepted forms: see this API argument contract at right | Standard layer controls. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard layer controls. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Native geom/stat parameters and fixed styles. |
geom_track_bar()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer input. Supply accver and source positions through x/pos, or interval start/end. Map y/track_value for identity values. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer input. Supply accver and source positions through x/pos, or interval start/end. Map y/track_value for identity values. |
position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Data position such as identity, stack, dodge. The legacy position=position_track(…) spelling still declares the physical band. |
baseline |
0 |
Numeric 0; count bars reject nonzero baselines | Count bars require baseline 0; every nonzero value is rejected. Use geom_track_col() for supplied values and nonzero baselines. |
fill |
"#86AFB9" |
Type, units and accepted forms: see this API argument contract at right | Fixed styles for the count shortcut. |
colour |
NA |
Type, units and accepted forms: see this API argument contract at right | Fixed styles for the count shortcut. |
alpha |
1 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles for the count shortcut. |
linewidth |
0.25 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles for the count shortcut. |
linetype |
1 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles for the count shortcut. |
bounds |
c("error", "clip") |
Type, units and accepted forms: see this API argument contract at right | Coordinate error/clip policy. |
show.legend |
NA |
Type, units and accepted forms: see this API argument contract at right | Standard layer controls. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard layer controls. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Native geom/stat parameters and fixed styles. |
geom_track_col()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer input. Supply accver and source positions through x/pos, or interval start/end. Map y/track_value for identity values. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer input. Supply accver and source positions through x/pos, or interval start/end. Map y/track_value for identity values. |
position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Data position such as identity, stack, dodge. The legacy position=position_track(…) spelling still declares the physical band. |
track |
NULL |
Type, units and accepted forms: see this API argument contract at right | A physical position_track() declaration. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Native geom/stat parameters and fixed styles. |
show.legend |
NA |
Type, units and accepted forms: see this API argument contract at right | Standard layer controls. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard layer controls. |
geom_track_line()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 mapping and layer input. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 mapping and layer input. |
position |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A position_track() declaration. Every layer requires one. |
colour |
"#387D88" |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; fill and colour mappings use the dedicated track roles and scoped scales. |
alpha |
1 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; fill and colour mappings use the dedicated track roles and scoped scales. |
linewidth |
0.4 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; fill and colour mappings use the dedicated track roles and scoped scales. |
linetype |
1 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; fill and colour mappings use the dedicated track roles and scoped scales. |
closed |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Explicitly close a complete circular line series. |
bounds |
c("error", "clip") |
Type, units and accepted forms: see this API argument contract at right | “error” (default) or “clip” for genomic coordinates. Clipping is reported and never changes source values. |
show.legend |
NA |
Type, units and accepted forms: see this API argument contract at right | Standard layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Extra geom parameters. |
geom_track_tile()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 mapping and layer input. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 mapping and layer input. |
position |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A position_track() declaration. Every layer requires one. |
fill |
"#86AFB9" |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; fill and colour mappings use the dedicated track roles and scoped scales. |
colour |
NA |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; fill and colour mappings use the dedicated track roles and scoped scales. |
alpha |
1 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; fill and colour mappings use the dedicated track roles and scoped scales. |
linewidth |
0.25 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; fill and colour mappings use the dedicated track roles and scoped scales. |
linetype |
1 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; fill and colour mappings use the dedicated track roles and scoped scales. |
bounds |
c("error", "clip") |
Type, units and accepted forms: see this API argument contract at right | “error” (default) or “clip” for genomic coordinates. Clipping is reported and never changes source values. |
show.legend |
NA |
Type, units and accepted forms: see this API argument contract at right | Standard layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Extra geom parameters. |
Local placement
position_feature_stack()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
spacing |
0.1 |
Type, units and accepted forms: see this API argument contract at right | Positive minimum radial distance between adjacent feature lanes. Circular plasmid layout enlarges the first transition into a main label corridor and reserves at least one label track between deeper overlapping feature lanes. |
side |
c("strand", "outside", "inside") |
Type, units and accepted forms: see this API argument contract at right | Legacy track-side selector retained for compatibility when base_position is NULL. Its historical names retain their existing geometry. |
base_position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional identity, strand, or plasmid Position applied before interval-overlap detection and lane allocation. |
position_plasmid()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
offset |
-0.1 |
Type, units and accepted forms: see this API argument contract at right | Signed local-normal offset. Negative values place the shared band inside a circular sequence and positive values place it outside. |
position_strand()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
offset |
0.1 |
Type, units and accepted forms: see this API argument contract at right | A finite scalar or a flexible per-sequence/per-strand specification. |
position_track()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
track |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | One stable nonempty character ID. |
side |
c("outside", "inside") |
Type, units and accepted forms: see this API argument contract at right | “outside” or “inside”. |
order |
1 |
Type, units and accepted forms: see this API argument contract at right | Finite ordering priority, nearest band first. Ties use ID order. |
width |
grid::unit(4, "mm") |
Type, units and accepted forms: see this API argument contract at right | Positive band width and nonnegative preceding gap. Absolute grid units (mm, cm, inches or points) are resolved against the render context. Numeric values retain native layout units. Numeric per-sequence vectors/lists follow the usual sequence parameter formats. |
gap |
grid::unit(1, "mm") |
Type, units and accepted forms: see this API argument contract at right | Positive band width and nonnegative preceding gap. Absolute grid units (mm, cm, inches or points) are resolved against the render context. Numeric values retain native layout units. Numeric per-sequence vectors/lists follow the usual sequence parameter formats. |
Link statistics
stat_ribbon_bundle()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer mapping and data arguments. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer mapping and data arguments. |
bins |
80L |
Type, units and accepted forms: see this API argument contract at right | Passed to bundle_ggchord_ribbons(). |
min_bundle |
2L |
Type, units and accepted forms: see this API argument contract at right | Passed to bundle_ggchord_ribbons(). |
weight |
c("length", "count", "pident") |
Type, units and accepted forms: see this API argument contract at right | Passed to bundle_ggchord_ribbons(). |
group_by |
NULL |
Type, units and accepted forms: see this API argument contract at right | Passed to bundle_ggchord_ribbons(). |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
show.legend |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Ribbon geometry and appearance arguments passed to geom_link_ribbon(). |
stat_ribbon_density()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer mapping and data arguments. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard layer mapping and data arguments. |
bins |
80L |
Type, units and accepted forms: see this API argument contract at right | Positive integer number of normalized midpoint bins per sequence. |
weight |
c("length", "count", "pident") |
Type, units and accepted forms: see this API argument contract at right | Density weight: “length”, “count”, or “pident”. |
group_by |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional columns that define independent density groups. |
position |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
show.legend |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
inherit.aes |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 layer arguments. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Ribbon geometry and appearance arguments passed to geom_link_ribbon(). |
Role scales
scale_feature_fill_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to ggplot2::scale_fill_manual(). |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A set of fill values to map data values to. |
limits |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional display order. Named feature values use their name order by default. |
scale_feature_fill_plasmid()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional scale arguments. |
limits |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional feature-type order. |
scale_feature_shape_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to ggplot2::discrete_scale(). |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A named or unnamed character vector of feature geometry names. |
name |
"Feature" |
Type, units and accepted forms: see this API argument contract at right | Scale and guide title, default “Feature”. |
limits |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional category order. Named values use their name order by default so shape and fill guides can merge cleanly. |
guide |
"none" |
Type, units and accepted forms: see this API argument contract at right | Guide specification. The default is “none” because geom_feature() combines shape silhouettes into its fill legend when both aesthetics describe the same feature categories. Supply guide_ggchord_legend() for a separate shape guide. |
scale_feature_shape_plasmid()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional scale arguments. |
limits |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional feature-type order. |
guide |
"none" |
Type, units and accepted forms: see this API argument contract at right | Guide used by the shape preset. |
scale_fill_residue()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
alphabet |
c("DNA", "RNA", "AA") |
Type, units and accepted forms: see this API argument contract at right | Select DNA, RNA or AA colors explicitly. Direct calls default to DNA; geom_residue() uses the data alphabet field when available, otherwise AA. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional arguments to ggplot2::scale_fill_manual(), including name, breaks and guide. Use scale_fill_manual() for custom colors. |
scale_gene_fill_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to ggplot2::scale_fill_manual(). |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A set of fill values to map data values to. |
scale_link_alpha_continuous()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
scale_link_alpha_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Manual aesthetic values. |
scale_link_color_gradientn()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
scale_link_color_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Manual aesthetic values. |
scale_link_colour_gradientn()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
scale_link_colour_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Manual aesthetic values. |
scale_link_linetype_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Manual aesthetic values. |
scale_link_linewidth_continuous()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
scale_link_linewidth_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Manual aesthetic values. |
scale_region_fill_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to ggplot2::scale_fill_manual(). |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A set of fill values to map data values to. |
scale_ribbon_alpha_continuous()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
range |
NULL |
Type, units and accepted forms: see this API argument contract at right | Output alpha range for a continuous scale. NULL uses the corresponding ggplot2 scale’s default range. |
scale_ribbon_alpha_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Manual aesthetic values. |
scale_ribbon_color_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Manual aesthetic values. |
scale_ribbon_colour_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Manual aesthetic values. |
scale_ribbon_fill_gradientn()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
colours |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Gradient colours. |
values |
NULL |
Type, units and accepted forms: see this API argument contract at right | Manual values, or positions for gradient colours where supported by the corresponding ggplot2 scale. |
colors |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Gradient colours. |
guide |
ggplot2::guide_colourbar(available_aes = "ribbon_fill") |
Type, units and accepted forms: see this API argument contract at right | A guide object; defaults accept the ribbon_fill aesthetic. |
scale_ribbon_fill_identity()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
scale_ribbon_fill_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Manual values, or positions for gradient colours where supported by the corresponding ggplot2 scale. |
scale_ribbon_fill_stepsn()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
colours |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Gradient colours. |
values |
NULL |
Type, units and accepted forms: see this API argument contract at right | Manual values, or positions for gradient colours where supported by the corresponding ggplot2 scale. |
colors |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Gradient colours. |
guide |
ggplot2::guide_coloursteps(available_aes = "ribbon_fill") |
Type, units and accepted forms: see this API argument contract at right | A guide object; defaults accept the ribbon_fill aesthetic. |
scale_ribbon_linetype_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to the corresponding ggplot2 scale. |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Manual aesthetic values. |
scale_seq_color_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to ggplot2::scale_colour_manual(). |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A set of aesthetic values to map data values to. |
scale_seq_colour_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to ggplot2::scale_colour_manual(). |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A set of aesthetic values to map data values to. |
scale_seq_position_continuous()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
name |
ggplot2::waiver() |
Type, units and accepted forms: see this API argument contract at right | Scale name; position guides are disabled by default. |
breaks |
ggplot2::waiver() |
Type, units and accepted forms: see this API argument contract at right | Standard continuous-scale controls. |
minor_breaks |
ggplot2::waiver() |
Type, units and accepted forms: see this API argument contract at right | Standard continuous-scale controls. |
labels |
ggplot2::waiver() |
Type, units and accepted forms: see this API argument contract at right | Standard continuous-scale controls. |
limits |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard continuous-scale controls. |
expand |
ggplot2::waiver() |
Type, units and accepted forms: see this API argument contract at right | Standard continuous-scale controls. |
oob |
scales::censor |
Type, units and accepted forms: see this API argument contract at right | Standard continuous-scale controls. |
transform |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Standard continuous-scale controls. |
n.breaks |
6 |
Type, units and accepted forms: see this API argument contract at right | Standard continuous-scale controls. |
coordinates |
c("relative", "source") |
Type, units and accepted forms: see this API argument contract at right | In linear layouts, use relative locus coordinates or original source coordinates retained by focus_ggchord_data(). This affects axis breaks and labels, not the underlying genomic geometry. Breaks returned in transformed scale space are converted back to genomic positions in every coordinate mode. Explicit breaks = NULL and minor_breaks = NULL suppress the corresponding ticks. |
sequences |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional character vector selecting sequence axes by their displayed accver. NULL keeps all axes; character() hides every axis. Focused or segmented views use window IDs, not parent source accessions. Unknown or undisplayed identifiers produce an error. This controls axis lines, ticks and labels together without dropping sequence geometry. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional arguments passed to ggplot2::continuous_scale(). |
scale_seq_ring_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Arguments passed to ggplot2::discrete_scale(). |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A named or unnamed numeric vector of positive radii. |
name |
"Ring" |
Type, units and accepted forms: see this API argument contract at right | Scale title. The guide is hidden by default because the scale controls geometry rather than a visible legend aesthetic. |
limits |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional ring order. |
guide |
"none" |
Type, units and accepted forms: see this API argument contract at right | Guide specification, default “none”. |
scale_track_colour_gradientn()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
track |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Track ID. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 scale arguments. |
colours |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Gradient colours. |
guide |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional standard guide for the fill/colour scale. |
scale_track_colour_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
track |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Track ID. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 scale arguments. |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Manual category colours. |
scale_track_fill_gradientn()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
track |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Track ID. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 scale arguments. |
colours |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Gradient colours. |
guide |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional standard guide for the fill/colour scale. |
scale_track_fill_manual()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
track |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Track ID. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 scale arguments. |
values |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Manual category colours. |
scale_track_value_continuous()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
track |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Track ID from position_track(). |
name |
track |
Type, units and accepted forms: see this API argument contract at right | Axis title, default the track ID. |
limits |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard continuous-scale controls. |
breaks |
ggplot2::waiver() |
Type, units and accepted forms: see this API argument contract at right | Standard continuous-scale controls. |
labels |
ggplot2::waiver() |
Type, units and accepted forms: see this API argument contract at right | Standard continuous-scale controls. |
transform |
"identity" |
Type, units and accepted forms: see this API argument contract at right | Standard continuous-scale controls. |
oob |
scales::censor |
Type, units and accepted forms: see this API argument contract at right | Standard continuous-scale controls. |
unit |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional data-unit label retained in track exports. |
guide |
c("axis", "none") |
Type, units and accepted forms: see this API argument contract at right | “axis” or “none” for the numerical track axis, or a native ggplot2::guide_axis() with local theme (axis.line/text/title), angle and check.overlap. Other guide_axis options fail explicitly because this sequence-local numerical reference is not a Cartesian panel axis. Local guide styling overrides global ggchord.track.axis.* theme elements. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional ggplot2 continuous-scale arguments. |
Legends and guides
guide_ggchord_colorbar()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
title |
ggplot2::waiver() |
Type, units and accepted forms: see this API argument contract at right | Guide title. |
theme |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional guide-specific theme. |
nbin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Number of colourbar bins. |
display |
"raster" |
Type, units and accepted forms: see this API argument contract at right | Colourbar display method. |
alpha |
NA |
Type, units and accepted forms: see this API argument contract at right | Colourbar alpha override. |
draw.ulim |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Whether to draw upper/lower limit ticks. |
draw.llim |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Whether to draw upper/lower limit ticks. |
angle |
NULL |
Type, units and accepted forms: see this API argument contract at right | Tick-label angle. |
position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Guide position and direction. |
direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Guide position and direction. |
reverse |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Whether to reverse the key order. |
order |
0 |
Type, units and accepted forms: see this API argument contract at right | Guide order. |
available_aes |
c("colour", "color", "fill", "ribbon_fill", "gene_fill", "feature_fill", "region_fill") |
Type, units and accepted forms: see this API argument contract at right | Aesthetics accepted by the guide. |
size_scale |
1 |
Type, units and accepted forms: see this API argument contract at right | Positive multiplier for keys, spacing and typography. ggchord’s automatically generated guides derive this from the active export device; direct calls default to 1. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional arguments passed to the corresponding ggplot2 guide. |
guide_ggchord_colourbar()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
title |
ggplot2::waiver() |
Type, units and accepted forms: see this API argument contract at right | Guide title. |
theme |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional guide-specific theme. |
nbin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Number of colourbar bins. |
display |
"raster" |
Type, units and accepted forms: see this API argument contract at right | Colourbar display method. |
alpha |
NA |
Type, units and accepted forms: see this API argument contract at right | Colourbar alpha override. |
draw.ulim |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Whether to draw upper/lower limit ticks. |
draw.llim |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Whether to draw upper/lower limit ticks. |
angle |
NULL |
Type, units and accepted forms: see this API argument contract at right | Tick-label angle. |
position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Guide position and direction. |
direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Guide position and direction. |
reverse |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Whether to reverse the key order. |
order |
0 |
Type, units and accepted forms: see this API argument contract at right | Guide order. |
available_aes |
c("colour", "color", "fill", "ribbon_fill", "gene_fill", "feature_fill", "region_fill") |
Type, units and accepted forms: see this API argument contract at right | Aesthetics accepted by the guide. |
size_scale |
1 |
Type, units and accepted forms: see this API argument contract at right | Positive multiplier for keys, spacing and typography. ggchord’s automatically generated guides derive this from the active export device; direct calls default to 1. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional arguments passed to the corresponding ggplot2 guide. |
guide_ggchord_legend()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
title |
ggplot2::waiver() |
Type, units and accepted forms: see this API argument contract at right | Guide title. |
theme |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional guide-specific theme. |
position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Guide position and direction. |
direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Guide position and direction. |
override.aes |
list() |
Type, units and accepted forms: see this API argument contract at right | A list of legend-key aesthetic overrides. |
nrow |
NULL |
Type, units and accepted forms: see this API argument contract at right | Legend key layout. |
ncol |
NULL |
Type, units and accepted forms: see this API argument contract at right | Legend key layout. |
reverse |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Whether to reverse the key order. |
order |
0 |
Type, units and accepted forms: see this API argument contract at right | Guide order. |
size_scale |
1 |
Type, units and accepted forms: see this API argument contract at right | Positive multiplier for keys, spacing and typography. ggchord’s automatically generated guides derive this from the active export device; direct calls default to 1. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional arguments passed to the corresponding ggplot2 guide. |
Themes and physical appearance
theme_ggchord()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
axis |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show automatic sequence axes, or ggplot2::element_blank() to hide the complete axis decoration. |
axis.line |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.minor.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis text element. |
axis.gap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.minor.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.text.offset |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.text.orientation |
NULL |
Type, units and accepted forms: see this API argument contract at right | One of “horizontal”, “parallel”, “perpendicular”, or a finite numeric angle. In circular layouts, parallel labels follow the circle glyph by glyph. Horizontal and numeric orientations retain straight text. |
axis.text.check.overlap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Whether overlapping axis labels are hidden. Defaults to TRUE. Automatically positioned circular parallel labels, including combined seam strings, can receive bounded inward or outward radial clearance around feature polygons and fixed annotation-leader roots. Internal and exterior annotation leaders route around the resolved axis text; mutable shoulders do not feed back into axis placement. Automatic strings stay in a near- backbone channel. Origin/end strings take priority and remain visible; an automatic endpoint may use either readable side of its tick, with a bounded tangential gap up to 4 mm, to clear fixed feature exit rays. Unresolved endpoint clearance is reported as endpoint_unresolved. Overlap checking may hide ordinary intermediate text while keeping its tick, with hidden_near_backbone in diagnostics. Explicit axis.text.offset values and explicit scale breaks stay fixed. |
seq.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
gene.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
gene.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
feature.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
feature.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
restriction.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
restriction.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
seq.center.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
seq.center.name |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
seq.center.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
legend.seq |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.seq.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.seq.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.seq.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.seq.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.seq.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.seq.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.seq.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.seq.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.seq.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.seq.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.link |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.ribbon |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.ribbon.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.ribbon.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.ribbon.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.ribbon.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.ribbon.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.ribbon.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.ribbon.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.ribbon.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.ribbon.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.ribbon.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.ribbon.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar lines. |
legend.ribbon.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar tick length. |
legend.ribbon.axis.line |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar lines. |
legend.gene |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.gene.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.gene.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.gene.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.gene.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.gene.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.gene.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.gene.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.gene.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.gene.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.gene.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.feature |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.feature.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.feature.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.feature.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.feature.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.feature.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.feature.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.feature.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.feature.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.feature.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.feature.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.region |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.region.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.region.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.region.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.region.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.region.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.region.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.region.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.region.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.region.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.region.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | 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. |
theme_ggchord_dark()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
axis |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show automatic sequence axes, or ggplot2::element_blank() to hide the complete axis decoration. |
axis.line |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.minor.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis text element. |
axis.gap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.minor.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.text.offset |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.text.orientation |
NULL |
Type, units and accepted forms: see this API argument contract at right | One of “horizontal”, “parallel”, “perpendicular”, or a finite numeric angle. In circular layouts, parallel labels follow the circle glyph by glyph. Horizontal and numeric orientations retain straight text. |
axis.text.check.overlap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Whether overlapping axis labels are hidden. Defaults to TRUE. Automatically positioned circular parallel labels, including combined seam strings, can receive bounded inward or outward radial clearance around feature polygons and fixed annotation-leader roots. Internal and exterior annotation leaders route around the resolved axis text; mutable shoulders do not feed back into axis placement. Automatic strings stay in a near- backbone channel. Origin/end strings take priority and remain visible; an automatic endpoint may use either readable side of its tick, with a bounded tangential gap up to 4 mm, to clear fixed feature exit rays. Unresolved endpoint clearance is reported as endpoint_unresolved. Overlap checking may hide ordinary intermediate text while keeping its tick, with hidden_near_backbone in diagnostics. Explicit axis.text.offset values and explicit scale breaks stay fixed. |
seq.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
gene.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
gene.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
feature.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
feature.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
restriction.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
restriction.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
seq.center.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
seq.center.name |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
seq.center.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
legend.seq |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.seq.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.seq.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.seq.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.seq.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.seq.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.seq.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.seq.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.seq.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.seq.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.seq.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.link |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.ribbon |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.ribbon.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.ribbon.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.ribbon.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.ribbon.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.ribbon.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.ribbon.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.ribbon.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.ribbon.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.ribbon.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.ribbon.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.ribbon.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar lines. |
legend.ribbon.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar tick length. |
legend.ribbon.axis.line |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar lines. |
legend.gene |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.gene.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.gene.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.gene.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.gene.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.gene.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.gene.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.gene.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.gene.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.gene.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.gene.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.feature |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.feature.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.feature.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.feature.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.feature.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.feature.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.feature.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.feature.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.feature.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.feature.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.feature.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.region |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.region.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.region.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.region.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.region.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.region.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.region.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.region.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.region.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.region.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.region.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | 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. |
theme_ggchord_minimal()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
axis |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show automatic sequence axes, or ggplot2::element_blank() to hide the complete axis decoration. |
axis.line |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.minor.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis text element. |
axis.gap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.minor.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.text.offset |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.text.orientation |
NULL |
Type, units and accepted forms: see this API argument contract at right | One of “horizontal”, “parallel”, “perpendicular”, or a finite numeric angle. In circular layouts, parallel labels follow the circle glyph by glyph. Horizontal and numeric orientations retain straight text. |
axis.text.check.overlap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Whether overlapping axis labels are hidden. Defaults to TRUE. Automatically positioned circular parallel labels, including combined seam strings, can receive bounded inward or outward radial clearance around feature polygons and fixed annotation-leader roots. Internal and exterior annotation leaders route around the resolved axis text; mutable shoulders do not feed back into axis placement. Automatic strings stay in a near- backbone channel. Origin/end strings take priority and remain visible; an automatic endpoint may use either readable side of its tick, with a bounded tangential gap up to 4 mm, to clear fixed feature exit rays. Unresolved endpoint clearance is reported as endpoint_unresolved. Overlap checking may hide ordinary intermediate text while keeping its tick, with hidden_near_backbone in diagnostics. Explicit axis.text.offset values and explicit scale breaks stay fixed. |
seq.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
gene.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
gene.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
feature.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
feature.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
restriction.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
restriction.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
seq.center.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
seq.center.name |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
seq.center.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
legend.seq |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.seq.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.seq.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.seq.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.seq.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.seq.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.seq.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.seq.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.seq.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.seq.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.seq.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.link |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.ribbon |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.ribbon.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.ribbon.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.ribbon.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.ribbon.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.ribbon.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.ribbon.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.ribbon.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.ribbon.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.ribbon.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.ribbon.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.ribbon.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar lines. |
legend.ribbon.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar tick length. |
legend.ribbon.axis.line |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar lines. |
legend.gene |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.gene.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.gene.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.gene.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.gene.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.gene.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.gene.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.gene.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.gene.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.gene.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.gene.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.feature |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.feature.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.feature.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.feature.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.feature.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.feature.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.feature.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.feature.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.feature.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.feature.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.feature.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.region |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.region.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.region.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.region.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.region.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.region.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.region.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.region.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.region.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.region.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.region.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | 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. |
theme_ggchord_plasmid()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
axis |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show automatic sequence axes, or ggplot2::element_blank() to hide the complete axis decoration. |
axis.line |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.minor.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis text element. |
axis.gap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.minor.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.text.offset |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.text.orientation |
NULL |
Type, units and accepted forms: see this API argument contract at right | One of “horizontal”, “parallel”, “perpendicular”, or a finite numeric angle. In circular layouts, parallel labels follow the circle glyph by glyph. Horizontal and numeric orientations retain straight text. |
axis.text.check.overlap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Whether overlapping axis labels are hidden. Defaults to TRUE. Automatically positioned circular parallel labels, including combined seam strings, can receive bounded inward or outward radial clearance around feature polygons and fixed annotation-leader roots. Internal and exterior annotation leaders route around the resolved axis text; mutable shoulders do not feed back into axis placement. Automatic strings stay in a near- backbone channel. Origin/end strings take priority and remain visible; an automatic endpoint may use either readable side of its tick, with a bounded tangential gap up to 4 mm, to clear fixed feature exit rays. Unresolved endpoint clearance is reported as endpoint_unresolved. Overlap checking may hide ordinary intermediate text while keeping its tick, with hidden_near_backbone in diagnostics. Explicit axis.text.offset values and explicit scale breaks stay fixed. |
seq.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
gene.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
gene.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
feature.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
feature.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
restriction.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
restriction.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
seq.center.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
seq.center.name |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
seq.center.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
legend.seq |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.seq.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.seq.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.seq.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.seq.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.seq.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.seq.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.seq.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.seq.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.seq.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.seq.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.link |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.ribbon |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.ribbon.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.ribbon.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.ribbon.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.ribbon.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.ribbon.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.ribbon.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.ribbon.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.ribbon.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.ribbon.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.ribbon.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.ribbon.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar lines. |
legend.ribbon.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar tick length. |
legend.ribbon.axis.line |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar lines. |
legend.gene |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.gene.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.gene.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.gene.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.gene.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.gene.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.gene.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.gene.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.gene.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.gene.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.gene.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.feature |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.feature.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.feature.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.feature.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.feature.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.feature.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.feature.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.feature.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.feature.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.feature.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.feature.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.region |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.region.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.region.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.region.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.region.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.region.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.region.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.region.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.region.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.region.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.region.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | 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. |
theme_ggchord_publication()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
axis |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show automatic sequence axes, or ggplot2::element_blank() to hide the complete axis decoration. |
axis.line |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.minor.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis line elements. |
axis.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Axis text element. |
axis.gap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.minor.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.text.offset |
NULL |
Type, units and accepted forms: see this API argument contract at right | Scalar grid::unit() objects controlling physical axis spacing. A negative axis.gap places the circular axis inside the backbone; a positive value places it outside. Zero attaches ticks to the inner backbone edge and is the circular default, including the plasmid preset. Circular major/minor tick lengths default to 1.5/0.7 mm, or 2.2/0.8 mm with the plasmid preset. Their default line widths are 0.45/0.3 mm, or 0.6/0.35 mm with that preset. Explicit length and line settings take priority. |
axis.text.orientation |
NULL |
Type, units and accepted forms: see this API argument contract at right | One of “horizontal”, “parallel”, “perpendicular”, or a finite numeric angle. In circular layouts, parallel labels follow the circle glyph by glyph. Horizontal and numeric orientations retain straight text. |
axis.text.check.overlap |
NULL |
Type, units and accepted forms: see this API argument contract at right | Whether overlapping axis labels are hidden. Defaults to TRUE. Automatically positioned circular parallel labels, including combined seam strings, can receive bounded inward or outward radial clearance around feature polygons and fixed annotation-leader roots. Internal and exterior annotation leaders route around the resolved axis text; mutable shoulders do not feed back into axis placement. Automatic strings stay in a near- backbone channel. Origin/end strings take priority and remain visible; an automatic endpoint may use either readable side of its tick, with a bounded tangential gap up to 4 mm, to clear fixed feature exit rays. Unresolved endpoint clearance is reported as endpoint_unresolved. Overlap checking may hide ordinary intermediate text while keeping its tick, with hidden_near_backbone in diagnostics. Explicit axis.text.offset values and explicit scale breaks stay fixed. |
seq.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
gene.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
gene.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
feature.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
feature.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
restriction.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
restriction.label.segment |
NULL |
Type, units and accepted forms: see this API argument contract at right | Line elements for gene, feature and restriction-site leader lines. |
seq.center.label |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
seq.center.name |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
seq.center.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Text elements for sequence, gene, feature, restriction-site and circular centre labels. |
legend.seq |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.seq.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.seq.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.seq.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.seq.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.seq.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.seq.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.seq.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.seq.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.seq.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.seq.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.seq.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.link |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.link.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Point-link guide appearance; follows the same role-specific rules. |
legend.ribbon |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.ribbon.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.ribbon.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.ribbon.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.ribbon.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.ribbon.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.ribbon.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.ribbon.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.ribbon.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.ribbon.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.ribbon.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.ribbon.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.ribbon.ticks |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar lines. |
legend.ribbon.ticks.length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar tick length. |
legend.ribbon.axis.line |
NULL |
Type, units and accepted forms: see this API argument contract at right | Ribbon colourbar lines. |
legend.gene |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.gene.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.gene.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.gene.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.gene.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.gene.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.gene.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.gene.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.gene.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.gene.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.gene.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.gene.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.feature |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.feature.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.feature.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.feature.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.feature.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.feature.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.feature.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.feature.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.feature.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.feature.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.feature.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.feature.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
legend.region |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL to show and inherit common settings, or ggplot2::element_blank() to hide every guide for that role. |
legend.region.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role guide positions. |
legend.region.direction |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role directions. |
legend.region.background |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role backgrounds. |
legend.region.key |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key elements. |
legend.region.key.size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.key.width |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.key.height |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role key dimensions. Automatic Identity rulers measure their boundary labels independently of generic legend swatch sizes. Set a Ribbon-specific dimension or an explicit guide for a manual ruler length. |
legend.region.text |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text elements. |
legend.region.text.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role text positions. |
legend.region.title |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title elements. |
legend.region.title.position |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role title positions. |
legend.region.margin |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role margins. |
legend.region.spacing |
NULL |
Type, units and accepted forms: see this API argument contract at right | Per-role spacing. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | 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. |
Input, conversion, diagnostics and output
adapt_ggchord()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
mode |
c("adaptive", "fixed", "scale") |
Type, units and accepted forms: see this API argument contract at right | One of adaptive, fixed, or scale. |
reference_size |
c(8, 6) |
Type, units and accepted forms: see this API argument contract at right | Positive width and height in inches. Scale modes use the fourth root of target/reference area, with a bounded text multiplier. |
text_scale_range |
c(0.85, 1.35) |
Type, units and accepted forms: see this API argument contract at right | Lower and upper positive text multipliers containing 1. Lines and default spacing use the square root of the text multiplier. |
min_text_size |
2.5 |
Type, units and accepted forms: see this API argument contract at right | Lower bound in mm for automatically reduced theme text. Defaults already smaller than this value are preserved rather than enlarged. Explicit text sizes and existing label-fit policies keep their own contracts. |
as_ggchord_alignment()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
sequences |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Named character vector of aligned strings, or a data frame with unique accver and character sequence. All strings must have the same positive width and each record must contain a nongap symbol. |
alphabet |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Explicit “DNA”, “RNA” or “AA”. IUPAC nucleotide ambiguity codes and protein ambiguity/rare-residue codes are accepted; * is accepted only for AA. The alphabet is never guessed. |
source_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional data frame with one row per alignment accver, start (first nongap source coordinate) and strand (“+” or “-”). Optional source_accver declares a different source ID; optional character sequence supplies the full forward source for verification. Coordinates must remain positive exact integers. Input metadata is retained in the ggchord_conversion attribute. |
circular |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Explicit logical declaration that every source is circular, default FALSE. Requires source_data with full source_length or full sequence. Coordinates wrap at that length in the declared strand direction; nongap characters may cover at most one complete tour. Adds source_circular and source_length columns. A circular plot never activates this conversion. |
as_ggchord_feature()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
x |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A data frame or GRanges object. |
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional named character vector mapping output roles to source columns, as in as_ggchord_seq(). |
as_ggchord_link()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
x |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A data frame or GInteractions object. |
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional named character vector mapping canonical link roles to source columns, as in as_ggchord_seq(). |
as_ggchord_seq()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
x |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A data frame, GRanges, Seqinfo, GInteractions, or a Biostrings XStringSet/XString object. |
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional named character vector output_role = “input_column” for data-frame inputs. For example c(accver = “chrom”, length = “size”). |
lengths |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional named numeric vector of known sequence lengths. Fills unknown lengths and must agree with any known source lengths. |
ids |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional character vector of explicit identifiers for unnamed XStringSet/XString inputs only. Existing source names must agree. |
build_ggchord_cds()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
cds_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Data frame with feature_id, accver, ordered one-based inclusive start/end, strand (+/-) and GFF3 phase (0–2, numeric or literal text as returned by read_gff3()). . remains unknown; unknown initial phase requires explicit codon_start for nested CDS. If type is present, select CDS rows explicitly before building a map. Alternatively supply one row per CDS with a segments list-column and explicit initial phase or codon_start (1–3). Nested genomic pieces retain explicit segment_order when supplied and are never replaced by the parent’s outer envelope. |
genetic_code |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional positive integer code ID, scalar or named by CDS feature_id. Must agree with a supplied genetic_code column. Missing IDs remain unknown; they do not prevent coordinate-only projection. |
partial |
c("error", "trim") |
Type, units and accepted forms: see this API argument contract at right | “error” (default) or explicit “trim”. |
bundle_ggchord_ribbons()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
ribbon_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Alignment data in ggchord ribbon format. |
seq_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Sequence data containing accver and length. |
bins |
80L |
Type, units and accepted forms: see this API argument contract at right | Positive integer number of normalized midpoint bins per sequence, default 80. |
min_bundle |
2L |
Type, units and accepted forms: see this API argument contract at right | Minimum number of rows required for aggregation, default 2. Smaller groups remain as individual ribbons. |
weight |
c("length", "count", "pident") |
Type, units and accepted forms: see this API argument contract at right | Bundle weight: “length”, “count”, or “pident”. Identity weight is aligned length multiplied by identity proportion. |
group_by |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional character columns that must agree before ribbons can be bundled. |
clean_ggchord_data()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
seq_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | data.frame/tibble, required. Must contain accver and length; used as the coordinate reference for clipping. Reference IDs must always be non-missing, non-empty and unique, regardless of unknown_id. |
ribbon_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | data.frame/tibble or NULL, optional. Alignment results. Other input types are rejected rather than treated as absent. |
gene_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | data.frame/tibble or NULL, optional. Gene annotation data. Other input types are rejected rather than treated as absent. |
unknown_id |
c("drop", "error", "keep") |
Type, units and accepted forms: see this API argument contract at right | Character, default “drop”. Policy for rows whose sequence ID in ribbon_data or gene_data is missing, empty or unknown: “drop” removes them, “error” stops with a message, “keep” leaves them unchanged. A kept row without a reference sequence is reported, but its coordinates and annotations are not cleaned and it is not guaranteed to be drawable. IDs are never guessed or replaced. Other structural checks, including finite numeric coordinates and valid gene strands, still apply. |
out_of_range |
c("clip", "drop", "error", "keep") |
Type, units and accepted forms: see this API argument contract at right | Character, default “clip”. Policy for coordinates outside [1, sequence length]: “clip” clamps them, “drop” removes the row, “error” stops, “keep” leaves them unchanged. Coordinates are one-based inclusive, so start == end is a valid single-base interval and is retained. With “clip”, intervals wholly outside their sequence are removed and reported; partially overlapping intervals retain their intersection, even a single base. |
reversed_interval |
c("sort", "drop", "error", "keep") |
Type, units and accepted forms: see this API argument contract at right | Character, default “sort”. Policy for intervals with start > end: “sort” swaps the endpoints so the feature draws stably (the original direction is recorded in the report), “drop” removes the row, “error” stops, “keep” leaves them unchanged. |
invalid_pident |
c("clip", "drop", "error", "keep") |
Type, units and accepted forms: see this API argument contract at right | Character, default “clip”. Policy for pident outside [0, 100]: “clip” clamps them, “drop” removes the row, “error” stops, “keep” leaves them unchanged. |
empty_annotation |
c("keep", "drop", "replace") |
Type, units and accepted forms: see this API argument contract at right | Character, default “keep”. Policy for missing/empty anno in gene data: “replace” fills them with replacement_annotation, “drop” removes the row, “keep” leaves them unchanged. |
replacement_annotation |
"unannotated" |
Type, units and accepted forms: see this API argument contract at right | Character, default “unannotated”. Replacement annotation used when empty_annotation = “replace”. |
feature_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Unified annotation input; mutually exclusive with gene_data. |
deduplicate_ggchord_ribbons()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
ribbon_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | data.frame in ribbon_data format. |
tolerance |
0 |
Type, units and accepted forms: see this API argument contract at right | Numeric, default 0. Maximum absolute difference (in bp) allowed on each of qstart/qend/sstart/send for two rows to count as coordinate duplicates (used with by = “coordinates”). |
by |
c("exact", "coordinates", "overlap") |
Type, units and accepted forms: see this API argument contract at right | Character, default “exact”. “exact” removes rows with identical pair and coordinates; “coordinates” additionally treats rows within tolerance bp as duplicates; “overlap” treats blocks whose reciprocal overlap is at least min_reciprocal_overlap on both sequences as duplicates. Each interval must meet the threshold, not only the shorter one. Opposite relative endpoint directions are kept as distinct relationships by all methods. Single-base endpoints use supplied strand/direction evidence; otherwise their direction is unknown. |
keep |
c("best_pident", "longest", "first") |
Type, units and accepted forms: see this API argument contract at right | Character, default “best_pident”. Which representative to keep: “best_pident” (highest pident), “longest” (longest length) or “first” (first occurrence in the input). |
min_reciprocal_overlap |
0.9 |
Type, units and accepted forms: see this API argument contract at right | Numeric (0-1), default 0.9. Reciprocal overlap threshold used with by = “overlap”. |
diagnose_ggchord()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
plot |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A ggchord plot. |
width |
7 |
Type, units and accepted forms: see this API argument contract at right | Positive target canvas dimensions. |
height |
5 |
Type, units and accepted forms: see this API argument contract at right | Positive target canvas dimensions. |
units |
c("in", "cm", "mm", "px") |
Type, units and accepted forms: see this API argument contract at right | Dimensions in “in”, “cm”, “mm”, or “px”. |
device |
c("png", "pdf", "svg") |
Type, units and accepted forms: see this API argument contract at right | Target device: “png”, “pdf”, or “svg”. It must be available in the current R environment. Only this device is inspected. |
dpi |
144 |
Type, units and accepted forms: see this API argument contract at right | Raster resolution; also defines pixel dimensions. |
min_size |
2 |
Type, units and accepted forms: see this API argument contract at right | Advisory minimum text size and line width, both in millimetres. These do not modify the supplied style. |
min_linewidth |
0.2 |
Type, units and accepted forms: see this API argument contract at right | Advisory minimum text size and line width, both in millimetres. These do not modify the supplied style. |
colour_vision |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Request optional simulated colour-vision hints. |
export_ggchord_fusion()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
plot |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A Fusion object. |
width |
10 |
Type, units and accepted forms: see this API argument contract at right | Positive canvas dimensions in inches. |
height |
8 |
Type, units and accepted forms: see this API argument contract at right | Positive canvas dimensions in inches. |
export_ggchord_layout()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
plot |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A ggchord plot. |
include |
c("seq", "ribbon", "gene", "feature", "labels", "axis", "track") |
Type, units and accepted forms: see this API argument contract at right | Character vector selecting any of “seq”, “ribbon”, “gene”, “feature”, “labels”, “alignment”, “link”, “restriction”, “track”, and “axis”. Point links and restriction sites require explicit selection. Dotplots default to alignment and axis; axis_layout contains reversible axis offsets, directions and source origins. Alignment exports retain all four endpoints, layer identity and source row; omissions appear in connection_report. |
original_data |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Include the resolved per-layer input tables under original_data, default FALSE. |
filter_ggchord_ribbons()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
ribbon_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | data.frame with at least qaccver and saccver columns (normally the full ribbon_data format). |
seq_ids |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional character vector. Keep only rows where both the query and the subject are in seq_ids. |
min_pident |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric. Lower/upper bounds on pident. |
max_pident |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric. Lower/upper bounds on pident. |
min_length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric. Lower bound on length. |
max_evalue |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric. Upper bound on evalue (requires an evalue column). |
min_bitscore |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric. Lower bound on bitscore (requires a bitscore column). |
min_query_coverage |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric (0-100). Lower bound on the query coverage. Uses the qcovs column when present; otherwise computed from qlen and the query interval (requires qlen). |
min_subject_coverage |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional numeric (0-100). Lower bound on the subject coverage, computed from slen and the subject interval (requires an slen column). |
keep_pairs |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional data.frame/list/matrix describing an undirected set of sequence pairs. A data.frame or matrix with the first two columns used as query/subject IDs, or a list of length-2 character vectors. A row is kept when its query/subject pair matches any pair in either direction. |
drop_self_links |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Logical, default TRUE. Remove rows where qaccver == saccver. |
sort_by |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional character vector of column names. Prefix a name with “-” or “desc:” for descending order (e.g. c(“pident”, “-evalue”)). |
filter_restriction_sites()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
sites |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Result from find_restriction_sites(). |
set |
c("all", "unique", "unique_dual", "six_plus", "unique_6plus", "commercial", "reference") |
Type, units and accepted forms: see this API argument contract at right | Display preset. “reference” reuses the enzyme-set profile stored for an exactly recognized reference sequence. It errors when no such profile is available. A saved “None” profile returns no sites. |
enzymes |
NULL |
Type, units and accepted forms: see this API argument contract at right | Additional filters. |
min_site_length |
NULL |
Type, units and accepted forms: see this API argument contract at right | Additional filters. |
cuts |
NULL |
Type, units and accepted forms: see this API argument contract at right | Additional filters. |
window |
NULL |
Type, units and accepted forms: see this API argument contract at right | Additional filters. |
commercial_only |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Additional filters. |
parent_set |
c("all", "commercial_all", "commercial_nonredundant") |
Type, units and accepted forms: see this API argument contract at right | Enzyme catalogue subset. “commercial_nonredundant” keeps one stable commercial representative per equivalent recognition group and site, preferring the database’s preferred enzyme when present. |
find_common_features()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
sequence |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | DNA text, a named character vector, or a data frame with accver and sequence. |
database |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional normalized database list or custom data frame. |
types |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional feature-type and feature-name/ID filters. |
features |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional feature-type and feature-name/ID filters. |
circular |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Search across the sequence origin. |
mode |
c("auto", "dna", "protein") |
Type, units and accepted forms: see this API argument contract at right | Matching mode. “auto” first uses curated annotations for an exactly known sequence, then follows each record’s detection mode. Records marked exactProteinMatch use exact protein followed by near-exact DNA; other records use exact DNA. “protein” explicitly enables exact and approximate protein matching. |
min_protein_identity |
0.9 |
Type, units and accepted forms: see this API argument contract at right | Approximate protein thresholds, each one finite number in [0, 1]. |
min_protein_coverage |
0.8 |
Type, units and accepted forms: see this API argument contract at right | Approximate protein thresholds, each one finite number in [0, 1]. |
resolve |
c("best", "all") |
Type, units and accepted forms: see this API argument contract at right | Return deterministic best annotations or every candidate. |
find_ggchord_loci()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
seq_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Sequence table containing unique accver and positive integer length values. Optional genome and genome_id columns are retained in the returned windows. |
feature_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Feature table containing feature_id, accver, start, end, and optionally strand. Missing strand means unknown. |
targets |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Non-empty character vector of distinct feature_id values. Selection is exact; no annotation text or accession versions are guessed. |
upstream |
0 |
Type, units and accepted forms: see this API argument contract at right | Single non-negative integer numbers of bases added before and after each target in its biological direction. |
downstream |
0 |
Type, units and accepted forms: see this API argument contract at right | Single non-negative integer numbers of bases added before and after each target in its biological direction. |
find_primer_bindings()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
sequence |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | DNA text, a named character vector, or a data frame with accver and sequence. |
primers |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional custom primers with sequence and optional name and primer_id (one ID per distinct sequence), or a named character vector. |
set |
c("universal", "all", "reference") |
Type, units and accepted forms: see this API argument contract at right | Bundled catalogue subset. reference returns authoritative primer annotations from a recognized bundled reference plasmid. |
match |
c("exact", "three_prime") |
Type, units and accepted forms: see this API argument contract at right | Full exact matching or longest exact 3-prime annealing. |
min_annealed_bases |
15L |
Type, units and accepted forms: see this API argument contract at right | One finite integer of at least 8, the minimum suffix length for three_prime matching. Fractional values are rejected. |
circular |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Allow matches to cross the sequence origin. |
unique_only |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Keep only primer sequences with one binding site per target. |
find_restriction_sites()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
sequence |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | DNA text, a named character vector, or a data frame with accver and sequence. |
enzymes |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional enzyme names. A data frame is a compatibility spelling for patterns. |
patterns |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional custom definitions. |
circular |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Allow recognition and cleavage coordinates to wrap origin. |
database |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional parsed pattern database. |
methylation |
c("auto", "none", "dam_dcm") |
Type, units and accepted forms: see this API argument contract at right | Methylation context. “auto” uses the audited context for recognized reference plasmids and otherwise makes no blocked-site claim; “none” disables blocking; “dam_dcm” evaluates source-backed Dam/Dcm sensitivities against the supplied sequence. |
focus_ggchord_data()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
seq_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Sequence table containing accver and length. |
ribbon_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional ggchord alignment table. |
gene_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional gene or feature table. |
loci |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Data frame containing accver, start, and end, and optionally locus_id. |
expand |
0 |
Type, units and accepted forms: see this API argument contract at right | Non-negative number of bases added on both sides, scalar or one value per locus. |
boundary |
c("trim", "drop") |
Type, units and accepted forms: see this API argument contract at right | Boundary policy. “trim” clips partially overlapping genes and alignments; “drop” keeps only rows fully contained in selected loci. |
feature_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Unified annotation input; mutually exclusive with gene_data. |
focus_ggchord_track()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Quantitative input table. Metadata and mapped values are retained. |
seq_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Sequence reference table. |
loci |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Explicit accver, start, end and optional locus_id, as in focus_ggchord_data(). |
type |
c("point", "interval") |
Type, units and accepted forms: see this API argument contract at right | “point” requires pos; “interval” requires start/end. |
boundary |
c("trim", "drop") |
Type, units and accepted forms: see this API argument contract at right | “trim” (default) or “drop” for partly retained intervals. |
fusion_panel()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
plot |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | An independent ggchord genomic plot, another Fusion, or a Cartesian detail from register_ggchord_alignment(). Dotplot, facets and unregistered external ggplots are not yet registered here. Character panels require explicit cross-panel fill; backbone-colour gradient is unavailable. |
id |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Unique nonempty panel name; “center” is reserved. |
side |
c("right", "top", "left", "bottom") |
Type, units and accepted forms: see this API argument contract at right | One of right, top, left, bottom, topright, topleft, bottomright or bottomleft (one panel per named side), or auto for a bounded clockwise perimeter layout with any number of distinct panels that fit the canvas. Auto preserves explicit sizes and all fixed allocations; unlocked default containers may adapt with a 15 mm floor. Placement does not rescale fonts or rotate the child Coord. If no placement is feasible, the build fails explicitly. |
size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional fractional width and height. Out-of-frame allocations fail; overlap fails unless explicitly allowed by the composition. |
box |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional explicit rectangle (xmin, xmax, ymin, ymax), optionally named in any order. Numeric values are fractions of the content area after native outer plot decorations and Guides; absolute grid units retain their physical size within that same frame. Use instead of side/size/angle/distance. Out-of-frame boxes fail at build. |
angle |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional finite placement angle in degrees counterclockwise from the right, instead of side. Does not rotate the plot or its labels. |
distance |
NULL |
Type, units and accepted forms: see this API argument contract at right | Positive radial distance from the centre allocation, as a fraction of half the shorter physical allocation dimension; default .8. Angles describe physical canvas directions even on rectangular devices. The allocation must fit without implicit clamping. |
fusion_ribbon()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A relationship data frame, preserving original endpoints. |
mapping |
NULL |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 aesthetic mapping: fill, colour, alpha, linewidth and linetype. With pident and no explicit fill, Identity is mapped by default with 0/50/80/90/95/100 breaks. Composition uses ordinary scale_fill_* etc.; panel role scales remain local to each panel. |
qpanel |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional fixed panel IDs. Do not also supply their columns. |
spanel |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional fixed panel IDs. Do not also supply their columns. |
gradient |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Opt in to query-to-subject sequence-colour interpolation. Cannot be combined with an explicit fill or fill mapping. |
tip |
c("none", "subject") |
Type, units and accepted forms: see this API argument contract at right | “none” or a decorative “subject” tip. Source fronts remain exported in full even when the tip is drawn. |
allow_repeated |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Explicitly allow repeated source_hsp_id display. |
curvature |
0.3 |
Type, units and accepted forms: see this API argument contract at right | Control distance relative to endpoint separation, in [0,1]. Nearly tangential arrivals use coherent perpendicular endpoint normals to avoid artificial S bends; ordered source fronts are never rearranged. |
fill |
NULL |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; explicit values take priority over mappings. The default fill without pident is steelblue. |
colour |
NA |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; explicit values take priority over mappings. The default fill without pident is steelblue. |
alpha |
0.35 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; explicit values take priority over mappings. The default fill without pident is steelblue. |
linewidth |
0.25 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; explicit values take priority over mappings. The default fill without pident is steelblue. |
linetype |
1 |
Type, units and accepted forms: see this API argument contract at right | Fixed styles; explicit values take priority over mappings. The default fill without pident is steelblue. |
show.legend |
NA |
Type, units and accepted forms: see this API argument contract at right | Standard ggplot2 legend selection: NA follows mappings; TRUE/FALSE or a named logical vector controls guide participation. |
route |
c("direct", "avoid", "bundle") |
Type, units and accepted forms: see this API argument contract at right | Default direct Bezier ribbons, or avoid for a measured obstacle route. Bundle requires an explicit route_group character column and shares a corridor for each group and ordered panel pair within the layer; every observation, source row, complete front and style remains independent. It does not aggregate evidence or imply biological flow. Avoid preserves complete interval fronts and uses a narrow polygonal corridor between them. Failure to find a clear route is explicit. |
route_width |
0.8 |
Type, units and accepted forms: see this API argument contract at right | Positive corridor width in mm for avoid/bundle (default .8). This is drawing width, not an alignment length or statistical weight. |
get_chord_layout()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
plot |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A ggchord plot. |
build |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Logical. Build the layout when it is not cached, default TRUE. |
ggchord()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
seq_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | data.frame/tibble with accver and length, or a GRanges, Seqinfo or GInteractions object with known full sequence lengths, or a named nucleotide or protein Biostrings XStringSet. Unnamed sequence objects must first use as_ggchord_seq() with explicit ids. Optional S4 inputs use as_ggchord_seq(). The sequence_unit column is “bp” (default when omitted) or “aa”. All rows use the same unit. Protein lengths come from complete proteins. Native aa plots accept links and generic features; gene, primer and restriction layers require bp. Arbitrary character widths are not biological sequence lengths. |
ribbon_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional alignment table with qaccver, saccver, qstart, qend, sstart and send. length and pident are optional unless requested by a mapping, filter or statistic. A GInteractions object uses as_ggchord_link() without inventing identity or alignment length. |
gene_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Compatible legacy annotation input. The third positional argument retains its meaning. Use feature_data in new code; a non-NULL legacy input emits one message at construction, never during rendering. Untyped legacy tables retain their directional gene semantics. No removal version is scheduled. Do not supply both annotation inputs. |
debug |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Whether to output debug information, default FALSE |
validate |
c("warn", "error", "none") |
Type, units and accepted forms: see this API argument contract at right | Character, default “warn”. How to run the structured input-data validation (see validate_ggchord_data): “warn” emits a single summary warning when the data has problems and caches the full report on the plot object (pggchordvalidation); “error” stops on severe problems; “none” skips the diagnostic validation (the cheap structural checks that prevent crashes are still performed). |
feature_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional unified annotation table or GRanges. Requires accver, start, end; absent strand becomes unknown (“.”). Generic feature layers use the full table. Default gene layers select gene/CDS from feature_class, type, or role (in that priority order), and require known strands. tRNA/rRNA remain generic features. Explicit layer data overrides the constructor input. Use disjoint subsets when combining gene and feature layers; each layer keeps its own data independently. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Reserved for clear migration errors from removed constructor arguments. Use labs(), coord_chord() and theme() for presentation. |
ggchord_fusion()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
center |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A ggchord genomic plot (Circular, Chord, Collinear, Sankey or Radial), or another Fusion. Nested biological endpoints use full panel paths. |
center_size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional width and height as fractions of the composition content area, excluding native outer plot decorations and cross-panel Guides. NULL allocates available space. |
layout |
c("fixed", "adaptive") |
Type, units and accepted forms: see this API argument contract at right | “fixed” uses fixed panel allocations; “adaptive” also adjusts the central allocation to the physical aspect ratio and jointly measures native cross-panel Guide candidates against panel allocations. Unlocked Guide positions/direction/rows may adapt; explicit native settings and absolute boxes stay fixed. Multiple outside Guide positions are allowed. Both rebuild labels and guides at actual panel sizes without shrinking explicit fonts. Impossible space constraints fail rather than dropping keys. |
allow_overlap |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Explicitly allow container overlap. Default FALSE fails on overlap. When TRUE, later panels paint over earlier panels. Connections use disjoint native grid clips to avoid accumulating translucent fills. Ordinary child margins do not break links; later containers still cover earlier content. This is deliberate placement, not global collision avoidance. |
center_box |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional centre allocation: xmin, xmax, ymin, ymax as four fractions of the composition content area excluding outer decorations and Guides, or four absolute grid units. Use instead of center_size. See fusion_panel(). |
guides |
c("keep", "collect") |
Type, units and accepted forms: see this API argument contract at right | “keep” (default) leaves child plot legends local. “collect” moves their native outside legends to the composition edge and removes visually identical duplicates. Scales are not combined or retrained across panels: use matching limits, breaks and guide styles for shared semantics. Different legends are retained separately, even with identical titles. Child legend.position = “none” stays hidden; inside legends cannot be collected. Nested cross-panel legends stay local to their composition. Collected boxes wrap to available device width. |
link_ggchord_clusters()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
feature_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Feature data frame with feature_id, accver, start, end, and optional strand, accepted by as_ggchord_feature(). |
membership |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Data frame with feature_id and cluster_id. A feature can belong to one cluster; extra columns are retained in the report. |
pairs |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Data frame with explicit qaccver and saccver comparisons. |
paralogs |
c("drop", "all") |
Type, units and accepted forms: see this API argument contract at right | How to handle multiple members per cluster and sequence: “drop” (default) or explicit “all”. |
segment_policy |
c("error", "span") |
Type, units and accepted forms: see this API argument contract at right | “error” (default) rejects repeated feature IDs; “span” explicitly uses a validated discontinuous feature’s outer bounds. |
max_links |
10000 |
Type, units and accepted forms: see this API argument contract at right | Positive integer upper limit for generated rows, default 10000. Exceeding it stops before Cartesian products are allocated. |
magnify_ggchord()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
plot |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A registered ggchord genomic source plot or nested Fusion. |
region |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Nonempty data frame with accver, start, end in original one-based inclusive source coordinates. Bounds must be ordered positive integers. Optional instance and detail_instance select exact display instances in the source and detail panels for every row. Ambiguity fails. Explicit wrap = TRUE permits start > end across a circular source origin. Both selected leaves must declare matching full source lengths; character sources require as_ggchord_alignment(circular = TRUE). The interval is drawn as two pieces with only its two external boundary leaders. With a list of details, a detail_panel column selects the named target for each row. Nested leaves use full paths, for example detail/center; optional source_panel similarly selects a source leaf under center. Ambiguous container selection fails. |
detail_plot |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | An explicit registered ggchord genomic plot, nested Fusion, a character plot from register_ggchord_alignment(), or a uniquely named list of such plots. Every panel must have at least one source region; the name center is reserved. The selected source interval must be fully visible in both panels, in the same bp/aa unit. Character plots require explicit source/column registration; ordinary unregistered plots are rejected. |
side |
c("right", "top", "left", "bottom") |
Type, units and accepted forms: see this API argument contract at right | A named side from fusion_panel(), including diagonal sides. For a list of plots, supply a character vector named by panel ID, with distinct fixed sides or repeated auto values for automatic perimeter allocation. Every input region still explicitly selects its detail panel. |
center_size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional panel width/height fractions, following ggchord_fusion() and fusion_panel(). Defaults reserve a smaller source panel and a wider detail container for a single detail plot. With multiple details, use a named list of sizes or NULL for Fusion defaults; center_size also follows Fusion defaults. Out-of-frame allocations fail; overlap requires explicit allow_overlap. |
detail_size |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional panel width/height fractions, following ggchord_fusion() and fusion_panel(). Defaults reserve a smaller source panel and a wider detail container for a single detail plot. With multiple details, use a named list of sizes or NULL for Fusion defaults; center_size also follows Fusion defaults. Out-of-frame allocations fail; overlap requires explicit allow_overlap. |
connector |
c("leader", "none", "envelope") |
Type, units and accepted forms: see this API argument contract at right | “leader” draws two decorative boundary leaders per row; “none” retains the highlights only. “envelope” groups selections by source/detail panel pair, outlines each exact source highlight band and frames the displayed detail sequences with their native labels (excluding plot titles and guides). Two leaders join actual source-band edges to the detail frame. Source selections are never enclosed in a padded combined rectangle. The detail frame is a display boundary, not a genomic interval. These are not biological ribbons or alignments. |
colour |
"#B45309" |
Type, units and accepted forms: see this API argument contract at right | Fixed highlight/leader colour. |
alpha |
0.2 |
Type, units and accepted forms: see this API argument contract at right | Highlight opacity in [0,1]; leaders use opaque colors. Character selections use unfilled cell outlines to preserve glyph contrast and residue colors; this opacity does not apply to those outlines. |
highlight_width |
1.5 |
Type, units and accepted forms: see this API argument contract at right | Positive highlight-band width in physical mm. Character panels outline the actual cell height instead. |
linewidth |
0.35 |
Type, units and accepted forms: see this API argument contract at right | Nonnegative leader width using the usual ggplot2 convention. |
linetype |
2 |
Type, units and accepted forms: see this API argument contract at right | Leader line type, default dashed. |
detail_box |
NULL |
Type, units and accepted forms: see this API argument contract at right | Explicit detail allocation instead of side/detail_size, using the box convention in fusion_panel(). For multiple plots, supply a named list covering every detail. Physical boxes are rechecked at target size. |
allow_overlap |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Deliberately permit overlapping containers, following ggchord_fusion(). Later panels cover earlier ones; default FALSE. |
center_box |
NULL |
Type, units and accepted forms: see this API argument contract at right | Explicit source allocation instead of center_size. |
route |
c("direct", "avoid") |
Type, units and accepted forms: see this API argument contract at right | Direct boundary leaders (default), or avoid to route around measured other containers and native text/guide envelopes. Endpoints stay fixed; no clear route fails rather than hiding the selection. |
guides |
c("keep", "collect") |
Type, units and accepted forms: see this API argument contract at right | Child legend placement, passed to ggchord_fusion(). Default “keep”; use “collect” for shared native outside legends. |
frame_region |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional data frame of ordered positive integer source start/end coordinates, in the same row order as region. Changes only source frames and leader departure points, retaining region, detail data and measured magnification. NULL uses exact selections. Optional accver must match region row by row. Frames must be fully visible in the same source instance; split frames or selections crossing the origin explicitly. |
map_alignment_position()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Long alignment frame from as_ggchord_alignment(). |
accver |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | One alignment-row ID, even if its source_accver differs. |
position |
No formal default; requiredness follows the contract |
Positive integers or NA; source positions or alignment columns | Numeric positions, positive integral or NA. |
inverse |
FALSE |
Type, units and accepted forms: see this API argument contract at right | FALSE maps alignment columns to source positions; TRUE maps source positions to alignment columns. |
map_ggchord_position()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
plot |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A ggchord plot using coord_collinear(), coord_radial_synteny() or coord_dotplot(). |
accver |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Sequence identifiers, scalar or one per position. |
position |
No formal default; requiredness follows the contract |
Numeric positions; Radial inverse uses an x/y matrix or data frame | Numeric genomic positions, or layout x when inverse = TRUE. Radial inverse mapping instead requires a matrix/data frame with x and y columns on the specified backbone. Off-backbone positions are rejected. |
inverse |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Convert layout x back to native sequence positions. |
source |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Use original source coordinates after focusing. |
axis |
NULL |
Type, units and accepted forms: see this API argument contract at right | Dotplot axis to map, either “x” (query) or “y” (subject). Required for Dotplots; omitted for linear and radial layouts. Dotplot gaps return NA on inverse mapping, with the chosen axis recorded in the result. |
merge_ggchord_ribbons()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
ribbon_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | data.frame in ribbon_data format. |
max_gap |
0 |
Type, units and accepted forms: see this API argument contract at right | Numeric, default 0. Maximum gap (in bp) allowed between two blocks on both sequences for them to be merged. |
min_pident_difference |
0 |
Type, units and accepted forms: see this API argument contract at right | Numeric, default 0. When > 0, two blocks are only merged when their pident difference is <= this value. |
require_same_orientation |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Logical, default TRUE. Only merge blocks with the same relative query/subject direction and compatible progression of their bounds. Reversing both endpoints preserves relative direction. FALSE explicitly permits a coarser mixed-direction summary. |
group_by |
c("qaccver", "saccver") |
Type, units and accepted forms: see this API argument contract at right | Character vector, default c(“qaccver”, “saccver”). Additional grouping columns; query/subject IDs always remain grouping keys. |
extra_columns |
c("consistent", "first") |
Type, units and accepted forms: see this API argument contract at right | How to handle columns other than the required ribbon fields when multiple rows are merged. “consistent” (default) keeps a value only when all source rows agree and otherwise stores a typed missing value; “first” retains the first source row’s value. |
optimize_ggchord_layout()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
seq_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Sequence data containing accver and length. |
ribbon_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Alignment data in ggchord ribbon format. |
seq_order |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional initial complete sequence order. The default uses the row order of seq_data. |
seq_orientation |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional initial orientation (1 or -1), scalar, complete vector, or named vector. |
optimize |
c("order", "orientation") |
Type, units and accepted forms: see this API argument contract at right | Any of “order” and “orientation”. |
weight |
c("length", "count", "pident") |
Type, units and accepted forms: see this API argument contract at right | Objective weight: “length”, “count”, or “pident”. |
max_iter |
50L |
Type, units and accepted forms: see this API argument contract at right | Positive integer maximum number of improving search rounds. |
prepare_ggchord_data()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
seq_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Sequence input accepted by as_ggchord_seq(). |
ribbon_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional paired intervals accepted by as_ggchord_link(). |
gene_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional directional gene input accepted by as_ggchord_feature(). Nondirectional intervals belong in features. |
features |
list() |
Type, units and accepted forms: see this API argument contract at right | Named lists of feature or paired-interval inputs. |
links |
list() |
Type, units and accepted forms: see this API argument contract at right | Named lists of feature or paired-interval inputs. |
mapping |
list() |
Type, units and accepted forms: see this API argument contract at right | Named list with optional seq, ribbon, gene column mappings, and features/links lists of mappings named like the respective collections. Each column mapping is a named character vector. |
steps |
list() |
Type, units and accepted forms: see this API argument contract at right | Named list of explicit helper argument lists. Supported names: clean, filter, deduplicate, merge, bundle, optimize. Data arguments are supplied by preparation and cannot be overridden. |
feature_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Unified annotation table, mutually exclusive with gene_data. |
primer_catalog()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
set |
c("all", "universal") |
Type, units and accepted forms: see this API argument contract at right | Return all records or only the commonly used universal subset. |
aliases |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Return source alias records instead of the sequence catalogue. |
project_ggchord_features()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
feature_data |
No formal default; requiredness follows the contract |
data.frame; one output per input feature, with pieces in segments | Domain/feature data frame with feature_id, parent_id (or a single-valued parent_ids list-column), start and end. |
cds |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A map from build_ggchord_cds(). |
from |
c("protein", "genome") |
Type, units and accepted forms: see this API argument contract at right | “protein” (default) or “genome”. |
codon_boundary |
c("error", "expand") |
Type, units and accepted forms: see this API argument contract at right | Inverse projection policy: “error” or “expand”. |
project_ggchord_links()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
link_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Data frame with qfeature_id, sfeature_id identifying CDS models and ordered inclusive protein qstart, qend, sstart, send. Query and subject residue spans must be equal. If present, gapopen must be zero and source length must equal this residue span. |
cds |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A map from build_ggchord_cds(). |
ungapped |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Must explicitly be TRUE, confirming an ungapped residue correspondence rather than inferring it from equal endpoint spans. |
read_aligned_fasta()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A single local aligned FASTA path; no multi-alignment concatenation. |
alphabet |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Explicit “DNA”, “RNA” or “AA”. IUPAC nucleotide ambiguity codes and protein ambiguity/rare-residue codes are accepted; * is accepted only for AA. The alphabet is never guessed. |
source_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional data frame with one row per alignment accver, start (first nongap source coordinate) and strand (“+” or “-”). Optional source_accver declares a different source ID; optional character sequence supplies the full forward source for verification. Coordinates must remain positive exact integers. Input metadata is retained in the ggchord_conversion attribute. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Also retain .source_file on each character row. |
circular |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Explicit logical declaration that every source is circular, default FALSE. Requires source_data with full source_length or full sequence. Coordinates wrap at that length in the declared strand direction; nongap characters may cover at most one complete tour. Adds source_circular and source_length columns. A circular plot never activates this conversion. |
read_bed()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional path vector or glob patterns; read before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional paths or wildcard patterns for multiple BED files. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Add a .source_file column, default FALSE. |
read_bedgraph()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional input path vector or glob patterns, before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional additional paths or wildcard patterns for bedGraph files. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Add .source_file to each row, default FALSE. |
read_bedpe()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional local path vector or glob patterns; read before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional additional local paths or glob patterns. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Add a .source_file column, default FALSE. |
unmapped |
c("error", "keep") |
Type, units and accepted forms: see this API argument contract at right | “error” (default) or “keep” for incomplete anchors. |
read_bigwig()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional local input path vector or glob patterns, before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional additional paths or wildcards for local BigWig files. |
which |
NULL |
Type, units and accepted forms: see this API argument contract at right | NULL for the whole file, or a GRanges / data frame with character accver and numeric start/end in one-based inclusive coordinates. Unknown accessions and out-of-bounds intervals fail explicitly. An empty selection returns no signal rows. The same selection applies to each file. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Add .source_file to each row, default FALSE. |
read_blast()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional path vector or glob patterns; read before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional character vector of BLAST tabular output files (literal paths and/or wildcard patterns). All matched files are read and combined into one data.frame. |
format |
c("auto", "outfmt6", "outfmt7", "custom") |
Type, units and accepted forms: see this API argument contract at right | Character. “auto” (default) detects the column layout from the file; “outfmt6” requires the standard 12-column layout, “outfmt7” parses its # Fields: declaration, and “custom” requires col_names. |
col_names |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional character vector naming the columns in the file, used with format = “custom” or to override auto-detection. |
comment |
"#" |
Type, units and accepted forms: see this API argument contract at right | Character comment character, default “#” (BLAST outfmt 7 header lines start with #). |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Add a .source_file column when reading one or more files, default FALSE. |
... |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Additional arguments passed to utils::read.table() (e.g. na.strings). |
read_chain()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional local path vector or glob patterns, before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional additional chain paths or patterns. |
query_ids |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional named character vectors mapping original query/target IDs to explicit source IDs. Unspecified IDs stay unchanged. Unknown map keys and conflicting full lengths fail. |
subject_ids |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional named character vectors mapping original query/target IDs to explicit source IDs. Unspecified IDs stay unchanged. Unknown map keys and conflicting full lengths fail. |
sequence_unit |
c("bp", "aa") |
Type, units and accepted forms: see this API argument contract at right | Declared coordinate unit, “bp” (default) or “aa”. The format itself cannot establish the biological unit. |
python |
"python3" |
Type, units and accepted forms: see this API argument contract at right | Existing interpreter with optional Biopython, default “python3”. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Add .source_file to ribbon rows, default FALSE. |
read_delta()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional local path vector or glob patterns, before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional additional delta paths or patterns. |
executable |
"show-coords" |
Type, units and accepted forms: see this API argument contract at right | Existing show-coords executable name or path, default “show-coords”. It must already be installed; no environment is modified. |
query_ids |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional explicit named source-ID maps, following read_chain(). Shared final IDs need explicit declaration on both sides and consistent full lengths. Defaults never auto-prefix IDs. |
subject_ids |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional explicit named source-ID maps, following read_chain(). Shared final IDs need explicit declaration on both sides and consistent full lengths. Defaults never auto-prefix IDs. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Add .source_file to ribbon rows, default FALSE. |
read_fasta_lengths()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional path vector or glob patterns; read before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional character vector of FASTA files (literal paths and/or wildcard patterns). All matched files are read and combined. |
header_delim |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional character. When given, each header is split at every occurrence of this delimiter and only the first piece is kept. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Add a .source_file column when reading one or more files, default FALSE. |
sequence_unit |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional “bp” or “aa” declaration. When supplied, adds that column to the result; the alphabet is not inferred. Omitted units retain the existing output columns and ggchord interprets them as bp. |
keep_sequence |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical, default FALSE. Also retain the actual FASTA characters in sequence, removing whitespace only and preserving case. No alphabet, reverse complement or alignment columns are inferred. Gap characters, if present, are counted in length; gapped input needs an explicit alignment-to-source map before genomic use. |
read_feature_relations()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional local paths or patterns, read before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional additional local paths or patterns. |
format |
c("pairs", "named_groups", "groups") |
Type, units and accepted forms: see this API argument contract at right | Explicit schema: “pairs” (default), “named_groups”, or “groups”. |
feature_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional data frame with unique character feature_id, character accver and numeric start/end in declared source coordinates. Original columns remain in report$feature_data; optional strand is retained. |
unmatched |
c("error", "report") |
Type, units and accepted forms: see this API argument contract at right | “error” (default) rejects IDs absent from supplied feature_data; “report” retains incomplete rows with mapping flags and reports each missing ID. Without feature_data all rows stay unplaced. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Add .source_file to pairs, membership and mapped links. |
read_genbank()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional path vector or glob patterns; read before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional paths or wildcard patterns for several files. |
feature_types |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional feature types to select. NULL retains all. |
lengths |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional named numeric vector of known full sequence lengths, following as_ggchord_seq(). |
python |
"python3" |
Type, units and accepted forms: see this API argument contract at right | Interpreter name or path, default “python3”. It must already have the optional Biopython package installed. No environment is modified. An explicit virtual-environment interpreter keeps its entry path rather than resolving its executable symlink into a different environment. |
unsupported |
c("error", "report") |
Type, units and accepted forms: see this API argument contract at right | “error” or “report” for locations without a safe local interval representation. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Add .source_file columns to output tables, default FALSE. File provenance is retained in the report regardless. |
read_gff3()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional path vector or glob patterns; read before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional character vector of GFF3 files (literal paths and/or wildcard patterns). All matched files are read and combined. |
feature_types |
"CDS" |
Type, units and accepted forms: see this API argument contract at right | Character vector of feature types to keep, default “CDS”. |
anno_from |
c("product", "Name", "gene", "ID") |
Type, units and accepted forms: see this API argument contract at right | Character vector of GFF3 attribute keys, tried in order to fill the anno column. |
unstranded |
c("plus", "drop", "keep") |
Type, units and accepted forms: see this API argument contract at right | “plus” (the default) assigns unknown strands to +; “drop” removes them. Use “keep” with geom_feature() to retain them as nondirectional . intervals. source_strand always records the input. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Add a .source_file column when reading one or more files, default FALSE. |
read_maf()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional local path vector or glob patterns, before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional additional MAF paths or patterns. |
alphabet |
"DNA" |
Type, units and accepted forms: see this API argument contract at right | Declared DNA, RNA or AA alphabet, default “DNA”. |
python |
"python3" |
Type, units and accepted forms: see this API argument contract at right | Existing interpreter with optional Biopython, default “python3”. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Add .source_file to alignment/ribbon rows, default FALSE. |
read_paf()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional path vector or glob patterns; read before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional paths or wildcard patterns for multiple PAF files. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Add a .source_file column, default FALSE. |
read_signature_matches()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional local path vector or glob patterns, before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional additional input paths or patterns. |
format |
c("scan_tsv", "entry_json") |
Type, units and accepted forms: see this API argument contract at right | Explicit schema: “scan_tsv” (default, 11-15 columns) or “entry_json” (cached entry results with metadata/proteins/locations). JSON requires optional jsonlite. No pagination links are followed; declared counts and remaining-page links stay in the report. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Add .source_file to feature rows, default FALSE. |
read_vcf()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
file |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional local path vector or glob patterns, before files. |
files |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional additional VCF/BCF paths or patterns. |
structural |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Explicitly request optional structural decoding, default FALSE. Duplicate record IDs fail in this mode because mates would be ambiguous. All source records remain accessible in the default mode. |
python |
"python3" |
Type, units and accepted forms: see this API argument contract at right | Existing interpreter with optional pysam for BCF only. Ignored for VCF text; default “python3”. No environment is modified. |
source_file |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Add .source_file to returned table rows, default FALSE. |
register_ggchord_alignment()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
plot |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Single-panel Cartesian ggplot containing geom_residue, mapping x = alignment_column, y = accver and label = symbol. Supports identity/reverse x scales and discrete y scales, with independent annotations. Rejects facets, nonlinear scales, flipped coordinates and positions moving registered characters. Supports geom_residue(line_width = …) wrapping; each selected source interval must fit within a displayed line. Split selections spanning lines explicitly. |
data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | The displayed rows of as_ggchord_alignment(), read_aligned_fasta() or translate_ggchord_cds()$nucleotides/residues. One cell per accver/alignment_column; source coordinates must be unique within each row. Keep original columns when filtering a window. Every selected source base must be present; split spliced regions explicitly. Origin-wrapping magnify regions require explicit circular source metadata. Gap columns remain visible but have no source coordinate. |
segment_ggchord_data()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
seq_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Full sequence table with unique accver and integer lengths. |
ribbon_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional paired interval table. |
gene_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional gene or generic feature table, including segments. |
windows |
No formal default; requiredness follows the contract |
Window data frame; fields and coordinates follow the argument contract | Table with accver, start, end, unique locus_id, optional row_id (defaults to source accver) and orientation (1 or -1, defaults to 1). Bounds must be ordered, integral and within the sequence. |
point_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional point links with qaccver, saccver, qpos, spos. |
cross_gap |
c("split", "drop") |
Type, units and accepted forms: see this API argument contract at right | How to handle interval links clipped by selected windows. |
max_links |
10000 |
Type, units and accepted forms: see this API argument contract at right | Positive integer upper bound on candidate ribbon/point copies. Increase explicitly for larger, intentionally overlapping views. |
feature_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Unified annotation input; mutually exclusive with gene_data. |
translate_ggchord_cds()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
cds |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A map from build_ggchord_cds(). |
sequences |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | Named character vector of complete forward source strings, or a data frame with unique accver and sequence (e.g. read_fasta_lengths() with keep_sequence = TRUE). DNAStringSet/RNAStringSet are also accepted. Every CDS source must exist and contain its declared intervals. |
alphabet |
c("DNA", "RNA") |
Type, units and accepted forms: see this API argument contract at right | Explicit “DNA” (default) or “RNA”; ungapped IUPAC only. |
initiation |
c("literal", "start") |
Type, units and accepted forms: see this API argument contract at right | “literal” (default) translates every codon literally. “start” uses the genetic code’s alternative initiation codons for the first codon only; it requires a complete biological 5-prime end. |
ambiguous |
c("error", "solve") |
Type, units and accepted forms: see this API argument contract at right | “error” (default) rejects ambiguous codons; “solve” uses Biostrings to resolve them, emitting X when not uniquely resolvable. |
validate_ggchord_data()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
seq_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | data.frame/tibble, required. Basic sequence information (columns accver, length). |
ribbon_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | data.frame/tibble, optional. Alignment results (columns qaccver, saccver, qstart, qend, sstart, send). |
gene_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | data.frame/tibble, optional. Gene annotation data (columns accver, start, end, strand; anno is optional). |
strict |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. When TRUE, collect issues and then stop if any severe problem is found. When FALSE (default), return the full diagnostic report without stopping. |
check_coordinates |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Logical, default TRUE. Whether to check that ribbon/gene coordinates stay inside [1, sequence length]. |
check_duplicates |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Logical, default TRUE. Whether to look for fully duplicated, near-duplicated and highly overlapping records. Reciprocal overlap requires the intersection to cover at least 90 percent of each interval, including descending ribbon endpoints. Reversed feature bounds may cross a circular origin and are excluded from linear overlap diagnostics; exact duplicates are still reported. |
check_self_links |
TRUE |
Type, units and accepted forms: see this API argument contract at right | Logical, default TRUE. Whether to flag alignment rows where qaccver == saccver. |
feature_data |
NULL |
Type, units and accepted forms: see this API argument contract at right | Unified annotation table, mutually exclusive with gene_data. Requires accver, start, end. Missing strand is unknown; +, -, ., and +/- are accepted. Reports use table “feature” and data_summary$n_feature; the input is never modified. |
validate_ggchord_hierarchy()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
seq_data |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A data frame containing accver and genome foreign keys. |
genomes |
No formal default; requiredness follows the contract |
Type, units and accepted forms: see this API argument contract at right | A data frame containing a unique genome primary key. |
strict |
FALSE |
Type, units and accepted forms: see this API argument contract at right | Logical. Stop if relational errors are present; warnings about genomes without contigs do not cause failure. |
view_ggchord()
| Parameter | Signature default | Type/value rule | Meaning, range and constraints |
|---|---|---|---|
plot |
ggplot2::last_plot() |
Type, units and accepted forms: see this API argument contract at right | A ggchord or ggplot object, default last_plot(). |
width |
12.39 |
Type, units and accepted forms: see this API argument contract at right | Positive output width. With no explicit dimensions, coord_chord() uses 12.39 inches while coord_circular() derives its width from the annotation envelope. |
height |
9.71 |
Type, units and accepted forms: see this API argument contract at right | Positive output height. With no explicit dimensions, coord_chord() uses 9.71 inches while coord_circular() derives both dimensions. Use NULL to fit the sequence, labels and legends while preserving equal coordinate units. Explicit width/height values are always respected. |
units |
c("in", "cm", "mm", "px") |
Type, units and accepted forms: see this API argument contract at right | Output units: “in”, “cm”, “mm”, or “px”. |
device |
c("png", "svg") |
Type, units and accepted forms: see this API argument contract at right | Preview device, “png” or “svg”. SVG output requires the optional svglite package or a working base Cairo SVG device. |
dpi |
144 |
Type, units and accepted forms: see this API argument contract at right | Positive raster resolution, default 144. |
bg |
NULL |
Type, units and accepted forms: see this API argument contract at right | Optional background colour passed to ggsave(). |
viewer |
c("auto", "ide", "browser", "none") |
Type, units and accepted forms: see this API argument contract at right | How to open the preview: “auto” prefers getOption(“viewer”) and falls back to a browser in interactive sessions; “ide”, “browser”, and “none” select an explicit destination. “none” is useful in scripts and tests. |
Upstream reexports and objects
These retain upstream ggplot2/grid semantics rather than defining new ggchord layers. After_stat and after_scale differ by stage even if identical compares their R objects equal.
aes · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
y |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
... |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
after_scale · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
after_stat · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
annotate · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
geom |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
x |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
y |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
xmin |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
xmax |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
ymin |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
ymax |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
xend |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
yend |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
... |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
na.rm |
FALSE |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
arrow · grid
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
angle |
30 |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
length |
unit(0.25, "inches") |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
ends |
"last" |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
type |
"open" |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
element_line · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
colour |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
linewidth |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
linetype |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
lineend |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
color |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
linejoin |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
arrow |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
arrow.fill |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
inherit.blank |
FALSE |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
size |
deprecated() |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
... |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
element_rect · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
fill |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
colour |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
linewidth |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
linetype |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
color |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
linejoin |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
inherit.blank |
FALSE |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
size |
deprecated() |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
... |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
element_text · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
family |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
face |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
colour |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
size |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
hjust |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
vjust |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
angle |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
lineheight |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
color |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
margin |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
debug |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
inherit.blank |
FALSE |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
... |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
expansion · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
mult |
0 |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
add |
0 |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
ggsave · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
filename |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
plot |
get_last_plot() |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
device |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
path |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
scale |
1 |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
width |
NA |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
height |
NA |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
units |
c("in", "cm", "mm", "px") |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
dpi |
300 |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
limitsize |
TRUE |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
bg |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
create.dir |
FALSE |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
... |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
ggtitle · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
label |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
subtitle |
waiver() |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
guides · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
... |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
labs · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
... |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
title |
waiver() |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
subtitle |
waiver() |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
caption |
waiver() |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
tag |
waiver() |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
dictionary |
waiver() |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
alt |
waiver() |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
alt_insight |
waiver() |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
margin · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
t |
0 |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
r |
0 |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
b |
0 |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
l |
0 |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
unit |
"pt" |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
... |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
rel · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
theme · ggplot2
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
... |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
line |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
rect |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
text |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
title |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
point |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
polygon |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
geom |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
spacing |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
margins |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
aspect.ratio |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.title |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.title.x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.title.x.top |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.title.x.bottom |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.title.y |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.title.y.left |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.title.y.right |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.text |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.text.x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.text.x.top |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.text.x.bottom |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.text.y |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.text.y.left |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.text.y.right |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.text.theta |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.text.r |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.x.top |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.x.bottom |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.y |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.y.left |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.y.right |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.theta |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.r |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.x.top |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.x.bottom |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.y.left |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.y.right |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.theta |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.r |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.length |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.length.x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.length.x.top |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.length.x.bottom |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.length.y |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.length.y.left |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.length.y.right |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.length.theta |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.ticks.length.r |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.length |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.length.x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.length.x.top |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.length.x.bottom |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.length.y |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.length.y.left |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.length.y.right |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.length.theta |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.minor.ticks.length.r |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.line |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.line.x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.line.x.top |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.line.x.bottom |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.line.y |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.line.y.left |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.line.y.right |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.line.theta |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
axis.line.r |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.background |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.margin |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.spacing |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.spacing.x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.spacing.y |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.key |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.key.size |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.key.height |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.key.width |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.key.spacing |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.key.spacing.x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.key.spacing.y |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.key.justification |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.frame |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.ticks |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.ticks.length |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.axis.line |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.text |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.text.position |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.title |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.title.position |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.position |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.position.inside |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.direction |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.byrow |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.justification |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.justification.top |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.justification.bottom |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.justification.left |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.justification.right |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.justification.inside |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.location |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.box |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.box.just |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.box.margin |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.box.background |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
legend.box.spacing |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.background |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.border |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.spacing |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.spacing.x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.spacing.y |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.grid |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.grid.major |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.grid.minor |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.grid.major.x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.grid.major.y |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.grid.minor.x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.grid.minor.y |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.ontop |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.widths |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
panel.heights |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
plot.background |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
plot.title |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
plot.title.position |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
plot.subtitle |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
plot.caption |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
plot.caption.position |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
plot.tag |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
plot.tag.position |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
plot.tag.location |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
plot.margin |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
strip.background |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
strip.background.x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
strip.background.y |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
strip.clip |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
strip.placement |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
strip.text |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
strip.text.x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
strip.text.x.bottom |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
strip.text.x.top |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
strip.text.y |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
strip.text.y.left |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
strip.text.y.right |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
strip.switch.pad.grid |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
strip.switch.pad.wrap |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
complete |
FALSE |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
validate |
TRUE |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
unit · grid
Upstream entry reference: Rd
| Parameter | Signature default | Type/contract |
|---|---|---|
x |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
units |
No formal default; see upstream contract |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |
data |
NULL |
Type, units and accepted forms: see this API argument contract at right; Follow upstream help for types, units and accepted values. |