Man pages for Rclade
Automated Deep-Time Phylogenetic Tree Collapsing and Visualization

add_clip_offApply coordinate-system clip="off" (the only clip application...
add_geo_eventsAdd geological event bands (e.g., GOE, NOE) to a tree plot
add_geo_timescaleAdd geological timescale to a tree plot
add_hpd_rangeAdd HPD (Highest Posterior Density) range to a tree plot
add_smart_legendAdd smart legend to a tree plot
add_support_labelsAdd node support labels to a tree plot
annotate_cladeAdd clade labels next to collapsed triangles
batch_plotBatch plot timetrees from a directory of tree files
batch_with_interruptExecute batch operation with interrupt handling and progress
build_base_treeCreate base tree plot based on layout type
build_full_taxa_dfBuild a full-rank taxonomy data.frame in a single pass (M-D4...
build_group_vecBuild a group vector from custom groups
build_pathBuild file path safely (cross-platform)
build_plot_timetree_paramsBuild plot_timetree parameter list from CLI options
build_taxonomy_lookupBuild taxonomy lookup from file
check_dependencyCheck a single dependency
check_example_treeCheck example tree loading and structure
check_input_validationCheck input validation functions
check_malicious_charsCheck for malicious characters in node names
check_monophylyCheck if a taxonomic group is monophyletic
check_monophyly_logicCheck monophyly logic with known cases
check_special_monophylyCheck if a special identifier corresponds to a monophyletic...
check_taxonomy_extractionCheck taxonomy extraction from example tree
cleanup_on_interruptClean up resources on interruption
compute_legend_layoutCompute legend row/column layout
compute_mrca_mapCompute MRCA node mapping for each taxonomic group
compute_time_breaksCompute adaptive time breaks for x-axis
compute_x_minCompute x-axis minimum from tree depth
convert_unitConvert time units (Ga -> Ma)
detect_alphabetDetect sequence alphabet from characters
detect_encodingDetect file encoding
detect_sequence_formatDetect sequence file format
detect_taxonomy_formatDetect taxonomy format from tip labels
detect_tree_formatDetect and validate tree file format
dot-acquire_log_lockAcquire an advisory file lock for the active log file (L-C5)
dot-rclade_extract_configExtract -config path from raw args (pre-parse)
dot-release_log_lockRelease the advisory log file lock acquired by...
ensure_dirEnsure directory exists, create if needed
escape_regexEscape a string for safe use inside a regular expression
example_treeExample phylogenetic tree with GTDB-style labels
find_rank_cyclesFind circular dependencies between two rank columns
format_elapsedFormat elapsed time
format_stepFormat step counter
format_timestampFormat timestamp in ISO 8601 with milliseconds and timezone...
generate_colorsGenerate color mapping for taxonomic groups
get_dependency_versionsGet dependency versions
get_git_hashGet the current git short hash of the installed package...
get_level_prefixGet level prefix
get_progress_summaryGet current progress summary
get_rank_nameGet display name for a taxonomic rank
get_supported_extensionsGet supported file extensions
get_taxonomy_levelsGet taxonomy level configuration
get_version_stringGet package version with git hash if available
highlight_cladesHighlight monophyletic clades on a tree plot
init_progress_trackingInitialize progress tracking for a batch operation
init_stepsInitialize step counter for progress tracking
level_to_numGet numeric value for log level
log_criticalLog a CRITICAL message
log_debugLog a DEBUG message
log_errorLog an ERROR message
log_infoLog an INFO message
log_keyvalueLog a key-value pair
log_memoryLog current memory usage at DEBUG level
log_messageLog a message with real-time flush
log_progressLog a progress indicator
log_sectionPrint a formatted section header
log_statsPrint summary statistics
log_subsectionPrint a formatted subsection header
log_tablePrint a formatted table
log_warningLog a WARNING message
managed_tempdirCreate and manage temporary directory with automatic cleanup
managed_tempfileCreate and manage temporary file with automatic cleanup
next_stepIncrement step counter
normalize_file_newlinesNormalize line endings in a file
normalize_newlinesNormalize line endings in text
normalize_rankNormalize rank abbreviation to full name
parse_custom_rankParse custom rank format labels (Format A wrapper)
parse_custom_regexParse custom regex format labels
parse_embeddedParse Format A: Embedded taxonomy labels
parse_gtdbParse GTDB format labels (wrapper for...
parse_ncbiParse NCBI format labels
parse_plot_paramsParse raw UI / CLI strings into structured plot parameters
parse_semicolon_delimitedParse Format B: Semicolon-delimited taxonomy (GTDB-style)
parse_silvaParse Silva format labels
parse_taxonomyUnified taxonomy parsing entry point
parse_taxonomy_with_fileParse taxonomy with external file support
plot_timetreePlot a phylogenetic tree with geological timescale and...
polytomy_treeExample phylogenetic tree with polytomies
prepare_geo_timescalesLoad internal geological timescale data
print.rclade_optionsPrint method for rclade_options
print_versionPrint version information
pt_single_treeSingle-tree plotting pipeline
pt_step1_prepare_inputsStep 1: Prepare and validate inputs
pt_step2_resolve_taxonomyStep 2: Resolve taxonomy / collapsing mode
pt_step3_compute_mrcaStep 3: Compute MRCA and check monophyly
pt_step4_generate_colorsStep 4: Generate colors
pt_step5_render_and_collapseStep 5: Render base tree and collapse clades
pt_step6_add_annotationsStep 6: Add annotations (tip labels, timescale, support, HPD,...
pt_step7_finalize_plotStep 7: Finalize plot (legend, theme, title, save, metadata)
RCLADE_HADEAN_ENDEnd of the Hadean eon / start of the Archean eon (Ma, ICS...
rclade_loggerRclade Logger
rclade_logoDisplay Rclade ASCII art logo
rclade_optionsConstruct a validated options list for 'plot_timetree()'
RCLADE_X_MARGIN_FACTORDefault margin factor for x-axis range extension
RCLADE_X_MIN_FLOORMinimum x-axis value used when the tree root reaches into the...
read_file_utf8Read file with explicit UTF-8 encoding
read_taxonomy_fileRead taxonomy information from a table file
read_tree_autoRead tree from file with automatic format detection
resolve_groupResolve group name or special identifier to MRCA node
resolve_special_identifierResolve special ancestral node identifiers
resolve_target_domainsResolve the target/expected taxonomy domains for a special...
resolve_taxonomy_source_priorityResolve taxonomy source priority (embedded vs table)
run_rclade_cliRun Rclade from the command line
run_rclade_selftestRun Rclade self-test
run_rclade_shinyLaunch Rclade Shiny app
save_session_infoSave sessionInfo() for reproducibility
save_timetreeSave a timetree plot to file
selftest_reportReport a self-test progress line
set_log_enabledEnable or disable logging
set_log_fileSet log file for dual output
set_log_levelSet log level
sort_by_depthSort groups by MRCA node depth (deepest first)
split_legendExtract legend as separate grob and combine with patchwork
strip_tree_annotationsStrip node annotations from a tree (ยง9.1.1...
summarize_multi_treesSummarize multiple trees in a file
summarize_taxonomy_qualityReport taxonomy label parsing quality
summarize_taxonomy_quality_with_fileSummarize taxonomy quality with external file support
summarize_timetreePrint a summary of a Rclade timetree plot
SUPPORTED_TREE_EXTENSIONSSupported tree file extensions
theme_timetreePublication-ready theme for timetree plots
timer_startStart a timer for performance measurement
timer_stopStop a timer and log elapsed time
update_progressUpdate progress counter
validate_cli_paramsValidate input parameters
validate_collapse_planDetect nesting conflicts in a collapse plan
validate_custom_groupsValidate user-defined custom groups for tree collapsing
validate_fasta_contentValidate FASTA content
validate_fastq_contentValidate FASTQ content
validate_file_existsValidate file existence and readability
validate_file_not_emptyValidate file is not empty
validate_inputsValidate and preprocess tree input
validate_newick_syntaxValidate Newick string syntax
validate_sequence_deepDeep validation of sequence files
validate_sequence_fileValidate sequence file format
validate_taxonomy_no_cyclesDetect circular dependencies in taxonomy table
validate_tree_deepDeep tree validation after parsing
validate_tree_sequence_matchCross-validate tree tip labels against sequence IDs
validate_tree_structureValidate tree object structure
with_graceful_interruptExecute expression with graceful interrupt handling
write_file_utf8Write file with explicit UTF-8 encoding and Unix line endings
Rclade documentation built on Sept. 26, 2026, 5:07 p.m.