roxygen2
In-Line Documentation for R

Package index
Search the roxygen2 package
Vignettes
Functions
677
Source code
161
Man pages
33
Home
/
CRAN
/
roxygen2: In-Line Documentation for R
/
API

API for roxygen2
In-Line Documentation for R

Global functions
.onLoad Source code
@aliases Man page
@backref Man page
@concept Man page
@describeIn Man page
@description Man page
@details Man page
@eval Man page
@evalNamespace Man page
@evalRd Man page
@example Man page
@examples Man page
@examplesIf Man page
@export Man page
@exportClass Man page
@exportMethod Man page
@exportPattern Man page
@exportS3Method Man page
@family Man page
@field Man page
@format Man page
@import Man page
@importClassesFrom Man page
@importFrom Man page
@importMethodsFrom Man page
@include Man page
@includeRmd Man page
@inherit Man page
@inheritDotParams Man page
@inheritParams Man page
@inheritSection Man page
@keywords Man page
@md Man page
@method Man page
@noMd Man page
@noRd Man page
@order Man page
@param Man page
@rawNamespace Man page
@rawRd Man page
@rdname Man page
@references Man page
@return Man page
@returns Man page
@section Man page
@seealso Man page
@slot Man page
@source Man page
@template Man page
@templateVar Man page
@title Man page
@usage Man page
@useDynLib Man page
RoxyTopic Man page
add_default_method_data Source code
add_default_methods Source code
add_rc_metadata Source code
add_s3_metadata Source code
args_call Source code
args_string Source code
author_desc Source code
author_type Source code
auto_backtick Source code
auto_quote Source code
base_packages Source code
base_path Source code
block_create Source code
block_evaluate Source code
block_find_object Source code
block_get_tag Man page Source code
block_get_tag_value Man page Source code
block_get_tags Man page Source code
block_has_tags Man page Source code
block_replace_tags Source code
block_set_env Source code
block_tags Source code
block_to_ns Source code
block_to_rd Source code
block_to_rd.default Source code
block_to_rd.roxy_block Source code
block_to_rd.roxy_block_r6class Source code
blocks_to_ns Source code
build_minidesc_metadata Source code
build_rd Source code
c.rd Source code
call_to_format Source code
call_to_object Source code
call_to_usage Source code
calls_use_method Source code
can_parse Source code
cat_line Source code
check_made_by Source code
collapse Source code
comments Source code
compact Source code
default_export Source code
default_export.NULL Source code
default_export.default Source code
default_export.rcclass Source code
default_export.s3method Source code
default_export.s4class Source code
default_export.s4generic Source code
default_export.s4method Source code
default_image_formats Source code
default_r6_methods Source code
detect_line_ending Source code
docstring Source code
dots Source code
double_escape_md Man page Source code
drop_clone_maybe Source code
env_file Man page Source code
env_package Man page Source code
escape Source code
escape.NULL Source code
escape.character Source code
escape.rd Source code
escapeExamples Source code
escape_comment Source code
escape_examples Man page Source code
escape_rd_for_md Man page Source code
escape_verb Source code
eval_code_node Source code
eval_code_nodes Source code
export Source code
export_class Source code
export_s3_method Source code
export_s4_method Source code
extract_method_fun Source code
extract_r6_bindings Source code
extract_r6_data Source code
extract_r6_fields Source code
extract_r6_methods Source code
extract_r6_self_data Source code
extract_r6_super_data Source code
findEndOfTag Source code
find_all_rd_tags Source code
find_all_tag_names Source code
find_and_filter_includes Source code
find_field Source code
find_fragile_rd_tags Source code
find_generic Source code
find_includes Source code
find_load_strategy Source code
find_method_for_tag Source code
find_object Source code
find_params Source code
find_sections Source code
find_topic_filename Source code
find_topic_in_package Source code
first_five Source code
first_time Source code
fits_constructor Source code
format.object Source code
format.rd_section Source code
format.rd_section_alias Source code
format.rd_section_author Source code
format.rd_section_backref Source code
format.rd_section_concept Source code
format.rd_section_description Source code
format.rd_section_details Source code
format.rd_section_docType Source code
format.rd_section_encoding Source code
format.rd_section_examples Source code
format.rd_section_family Source code
format.rd_section_field Source code
format.rd_section_formals Source code
format.rd_section_format Source code
format.rd_section_inherit Source code
format.rd_section_inherit_dot_params Source code
format.rd_section_inherit_section Source code
format.rd_section_keyword Source code
format.rd_section_minidesc Source code
format.rd_section_name Source code
format.rd_section_note Source code
format.rd_section_package Source code
format.rd_section_param Source code
format.rd_section_rawRd Source code
format.rd_section_rcmethods Source code
format.rd_section_reexport Source code
format.rd_section_references Source code
format.rd_section_section Source code
format.rd_section_seealso Source code
format.rd_section_slot Source code
format.rd_section_source Source code
format.rd_section_title Source code
format.rd_section_usage Source code
format.rd_section_value Source code
format.roxy_tag Source code
format_classes Source code
format_collapse Source code
format_dim Source code
format_first Source code
format_rd Source code
format_section Source code
function_usage Source code
generate_collate Source code
get_documented_params Source code
get_image_format Source code
get_md_linkrefs Source code
get_method Source code
get_rd Source code
get_rd_from_help Source code
get_tags Source code
has_quotes Source code
has_topic Source code
ignore_files Source code
inherit_dot_params Source code
inherit_field Source code
inherit_params Source code
inherit_section Source code
inherit_sections Source code
internal_f Source code
invert Source code
is.roclet Source code
is.roxy_tag Source code
is.s3 Source code
is.s3generic Source code
is.s3method Source code
is_infix_fun Source code
is_markdown_code_node Source code
is_namespaced Source code
is_padded_infix_fun Source code
is_replacement_fun Source code
is_roxy_block Source code
is_s3_generic Man page Source code
is_s3_method Man page Source code
is_syntactic Source code
itemize Source code
knitr_chunk_defaults Source code
leadingSpaces Source code
load Man page
load_installed Man page Source code
load_options Man page Source code
load_options_description Source code
load_options_meta Source code
load_pkgload Man page Source code
load_source Man page Source code
local_markdown Source code
local_pkg_deps Source code
local_reproducible_output Source code
local_roxy_meta_set Source code
made_by Source code
made_by_roxygen Source code
make_as_character_rd Source code
make_random_string Source code
markdown Source code
markdown-test Man page
markdown_activate Source code
markdown_if_active Source code
markdown_on Source code
markdown_pass1 Man page Source code
markdown_pass2 Source code
match_param Source code
md_to_mdxml Source code
mdxml_break Source code
mdxml_children_to_rd Source code
mdxml_children_to_rd_top Source code
mdxml_close_sections Source code
mdxml_code Source code
mdxml_code_block Source code
mdxml_heading Source code
mdxml_html_block Source code
mdxml_html_inline Source code
mdxml_image Source code
mdxml_item Source code
mdxml_link Source code
mdxml_link_text Source code
mdxml_list Source code
mdxml_node_to_rd Source code
mdxml_table Source code
mdxml_unknown Source code
mdxml_unsupported Source code
merge.rd_section Source code
merge.rd_section_author Source code
merge.rd_section_inherit Source code
merge.rd_section_inherit_dot_params Source code
merge.rd_section_inherit_section Source code
merge.rd_section_minidesc Source code
merge.rd_section_param Source code
merge.rd_section_reexport Source code
merge.rd_section_section Source code
move_names_to_front Source code
mtime Source code
namespace_exports Source code
namespace_imports Source code
namespace_imports_blocks Source code
namespace_roclet Man page Source code
needs_doc Source code
nice_name Source code
object Man page Source code
object_defaults Source code
object_defaults.data Source code
object_defaults.default Source code
object_defaults.function Source code
object_defaults.import Source code
object_defaults.package Source code
object_defaults.r6class Source code
object_defaults.rcclass Source code
object_defaults.s4class Source code
object_format Man page Source code
object_format.default Source code
object_from_call Source code
object_from_name Source code
object_name Source code
object_name.default Source code
object_name.function Source code
object_name.s3method Source code
object_name.s4generic Source code
object_name.s4method Source code
object_name_fun Source code
object_topic Source code
object_usage Source code
object_usage.data Source code
object_usage.default Source code
object_usage.function Source code
object_usage.s3method Source code
object_usage.s4generic Source code
object_usage.s4method Source code
one_per_line Source code
one_per_line_ignore_current Source code
order_blocks Source code
order_c Source code
package_authors Source code
package_files Source code
package_seealso Source code
package_seealso_urls Source code
package_suffix Source code
package_url_parse Source code
parse_description Source code
parse_file Man page Source code
parse_lines Source code
parse_md_pos Source code
parse_package Man page Source code
parse_rd Source code
parse_tags Source code
parse_text Man page Source code
parser_assignment Source code
parser_data Source code
parser_delayedAssign Source code
parser_import Source code
parser_package Source code
parser_setClass Source code
parser_setClassUnion Source code
parser_setConstructorS3 Source code
parser_setGeneric Source code
parser_setMethod Source code
parser_setMethodS3 Source code
parser_setRefClass Source code
parser_setReplaceMethod Source code
peek_roxygen_pkg Source code
pkg_env Source code
print.object Source code
print.rd Source code
print.rd_section Source code
print.roxy_block Source code
print.roxy_tag Source code
process_templates Source code
protect_rd_tags Source code
r6_active_bindings Source code
r6_all_examples Source code
r6_fields Source code
r6_inherited_method_list Source code
r6_method_begin Source code
r6_method_description Source code
r6_method_details Source code
r6_method_end Source code
r6_method_examples Source code
r6_method_list Source code
r6_method_params Source code
r6_method_return Source code
r6_method_usage Source code
r6_methods Source code
r6_show_name Source code
r6_superclass Source code
r_files Source code
rc_methods Source code
rd Source code
rd2text Source code
rdComplete Source code
rd_macro Source code
rd_roclet Man page Source code
rd_section Man page Source code
rd_section_description Source code
rd_section_inherit Source code
rd_section_inherit_dot_params Source code
rd_section_inherit_section Source code
rd_section_markdown Source code
rd_section_minidesc Source code
rd_section_reexport Source code
rd_section_section Source code
readLines Source code
read_lines Source code
repeat_first Source code
repeat_first_ignore_current Source code
resolve_qualified_link Source code
rmd_eval_rd Source code
rmd_linkrefs_from_file Source code
roc_proc_text Man page Source code
roclet Man page Source code
roclet_clean Man page Source code
roclet_clean.roclet_namespace Source code
roclet_clean.roclet_rd Source code
roclet_find Man page Source code
roclet_output Man page Source code
roclet_output.roclet_namespace Source code
roclet_output.roclet_rd Source code
roclet_output.roclet_vignette Source code
roclet_preprocess Man page Source code
roclet_preprocess.default Source code
roclet_process Man page Source code
roclet_process.roclet_namespace Source code
roclet_process.roclet_rd Source code
roclet_process.roclet_vignette Source code
roclet_tags Man page Source code
roxy_block Man page Source code
roxy_eval Source code
roxy_generated_tag Source code
roxy_knit Source code
roxy_meta_clear Source code
roxy_meta_get Man page Source code
roxy_meta_load Source code
roxy_meta_set Source code
roxy_tag Man page Source code
roxy_tag_eval Source code
roxy_tag_ns Source code
roxy_tag_ns.default Source code
roxy_tag_ns.roxy_tag_evalNamespace Source code
roxy_tag_ns.roxy_tag_export Source code
roxy_tag_ns.roxy_tag_exportClass Source code
roxy_tag_ns.roxy_tag_exportMethod Source code
roxy_tag_ns.roxy_tag_exportPattern Source code
roxy_tag_ns.roxy_tag_exportS3Method Source code
roxy_tag_ns.roxy_tag_import Source code
roxy_tag_ns.roxy_tag_importClassesFrom Source code
roxy_tag_ns.roxy_tag_importFrom Source code
roxy_tag_ns.roxy_tag_importMethodsFrom Source code
roxy_tag_ns.roxy_tag_rawNamespace Source code
roxy_tag_ns.roxy_tag_useDynLib Source code
roxy_tag_parse Man page Source code
roxy_tag_parse.default Source code
roxy_tag_parse.roxy_tag_aliases Source code
roxy_tag_parse.roxy_tag_author Source code
roxy_tag_parse.roxy_tag_backref Source code
roxy_tag_parse.roxy_tag_concept Source code
roxy_tag_parse.roxy_tag_describeIn Source code
roxy_tag_parse.roxy_tag_description Source code
roxy_tag_parse.roxy_tag_details Source code
roxy_tag_parse.roxy_tag_docType Source code
roxy_tag_parse.roxy_tag_encoding Source code
roxy_tag_parse.roxy_tag_eval Source code
roxy_tag_parse.roxy_tag_evalNamespace Source code
roxy_tag_parse.roxy_tag_evalRd Source code
roxy_tag_parse.roxy_tag_example Source code
roxy_tag_parse.roxy_tag_examples Source code
roxy_tag_parse.roxy_tag_examplesIf Source code
roxy_tag_parse.roxy_tag_export Source code
roxy_tag_parse.roxy_tag_exportClass Source code
roxy_tag_parse.roxy_tag_exportMethod Source code
roxy_tag_parse.roxy_tag_exportPattern Source code
roxy_tag_parse.roxy_tag_exportS3Method Source code
roxy_tag_parse.roxy_tag_family Source code
roxy_tag_parse.roxy_tag_field Source code
roxy_tag_parse.roxy_tag_format Source code
roxy_tag_parse.roxy_tag_import Source code
roxy_tag_parse.roxy_tag_importClassesFrom Source code
roxy_tag_parse.roxy_tag_importFrom Source code
roxy_tag_parse.roxy_tag_importMethodsFrom Source code
roxy_tag_parse.roxy_tag_include Source code
roxy_tag_parse.roxy_tag_includeRmd Source code
roxy_tag_parse.roxy_tag_inherit Source code
roxy_tag_parse.roxy_tag_inheritDotParams Source code
roxy_tag_parse.roxy_tag_inheritParams Source code
roxy_tag_parse.roxy_tag_inheritSection Source code
roxy_tag_parse.roxy_tag_keywords Source code
roxy_tag_parse.roxy_tag_md Source code
roxy_tag_parse.roxy_tag_method Source code
roxy_tag_parse.roxy_tag_name Source code
roxy_tag_parse.roxy_tag_noMd Source code
roxy_tag_parse.roxy_tag_noRd Source code
roxy_tag_parse.roxy_tag_note Source code
roxy_tag_parse.roxy_tag_order Source code
roxy_tag_parse.roxy_tag_param Source code
roxy_tag_parse.roxy_tag_rawNamespace Source code
roxy_tag_parse.roxy_tag_rawRd Source code
roxy_tag_parse.roxy_tag_rdname Source code
roxy_tag_parse.roxy_tag_references Source code
roxy_tag_parse.roxy_tag_return Source code
roxy_tag_parse.roxy_tag_section Source code
roxy_tag_parse.roxy_tag_seealso Source code
roxy_tag_parse.roxy_tag_slot Source code
roxy_tag_parse.roxy_tag_source Source code
roxy_tag_parse.roxy_tag_template Source code
roxy_tag_parse.roxy_tag_templateVar Source code
roxy_tag_parse.roxy_tag_title Source code
roxy_tag_parse.roxy_tag_usage Source code
roxy_tag_parse.roxy_tag_useDynLib Source code
roxy_tag_rd Man page Source code
roxy_tag_rd.default Source code
roxy_tag_rd.roxy_tag_.formals Source code
roxy_tag_rd.roxy_tag_.methods Source code
roxy_tag_rd.roxy_tag_.package Source code
roxy_tag_rd.roxy_tag_.reexport Source code
roxy_tag_rd.roxy_tag_author Source code
roxy_tag_rd.roxy_tag_backref Source code
roxy_tag_rd.roxy_tag_concept Source code
roxy_tag_rd.roxy_tag_description Source code
roxy_tag_rd.roxy_tag_details Source code
roxy_tag_rd.roxy_tag_docType Source code
roxy_tag_rd.roxy_tag_encoding Source code
roxy_tag_rd.roxy_tag_evalRd Source code
roxy_tag_rd.roxy_tag_example Source code
roxy_tag_rd.roxy_tag_examples Source code
roxy_tag_rd.roxy_tag_examplesIf Source code
roxy_tag_rd.roxy_tag_family Source code
roxy_tag_rd.roxy_tag_field Source code
roxy_tag_rd.roxy_tag_format Source code
roxy_tag_rd.roxy_tag_includeRmd Source code
roxy_tag_rd.roxy_tag_inherit Source code
roxy_tag_rd.roxy_tag_inheritDotParams Source code
roxy_tag_rd.roxy_tag_inheritParams Source code
roxy_tag_rd.roxy_tag_inheritSection Source code
roxy_tag_rd.roxy_tag_keywords Source code
roxy_tag_rd.roxy_tag_note Source code
roxy_tag_rd.roxy_tag_param Source code
roxy_tag_rd.roxy_tag_rawRd Source code
roxy_tag_rd.roxy_tag_references Source code
roxy_tag_rd.roxy_tag_return Source code
roxy_tag_rd.roxy_tag_section Source code
roxy_tag_rd.roxy_tag_seealso Source code
roxy_tag_rd.roxy_tag_slot Source code
roxy_tag_rd.roxy_tag_source Source code
roxy_tag_rd.roxy_tag_title Source code
roxy_tag_rd.roxy_tag_usage Source code
roxy_tag_warning Man page Source code
roxy_test_tag Source code
roxygen2 Man page
roxygen2-package Man page
roxygen_setup Source code
roxygen_version Source code
roxygenise Man page
roxygenize Man page Source code
s3_method Source code
s3_method_info Source code
same_contents Source code
select_args Source code
select_args_text Source code
set_collate Source code
sig2class Source code
sort_c Source code
str_set_all_pos Source code
str_sub_same Source code
strip Source code
strip_quotes Source code
sys_source Source code
tag_aliases Source code
tag_code Man page Source code
tag_examples Man page Source code
tag_inherit Man page Source code
tag_markdown Man page Source code
tag_markdown_with_sections Man page Source code
tag_name Man page Source code
tag_name_description Man page Source code
tag_parsers Man page
tag_toggle Man page Source code
tag_two_part Man page Source code
tag_value Man page Source code
tag_words Man page Source code
tag_words_line Man page Source code
tags-index-crossref Man page
tags-namespace Man page
tags-rd Man page
tags-rd-formatting Man page
tags-rd-other Man page
tags-reuse Man page
tags_list Man page Source code
tags_metadata Man page Source code
tags_rd Source code
tags_rd_section Source code
template_eval Source code
template_find Source code
tokenise_block Source code
tokenise_ref Source code
tokenize_file Source code
topic_add_describe_in Source code
topic_add_name_aliases Source code
topic_add_r6_methods Source code
topic_params Source code
topics_add_default_description Source code
topics_add_package_alias Source code
topics_fix_params_order Source code
topics_process_family Source code
topics_process_family_prefix Source code
topics_process_inherit Source code
trim_docstring Source code
try_find_topic_in_package Source code
tweak_links Source code
unescape_rd_for_md Man page Source code
update_collate Man page Source code
update_namespace_imports Source code
update_roxygen_version Source code
usage_args Source code
uuid Source code
vign_outdated Source code
vign_update Source code
vign_update_all Source code
vignette_roclet Man page Source code
warn_missing_s3_exports Source code
warn_roxy Source code
warn_roxy_block Source code
warn_roxy_function Source code
warn_roxy_tag Man page Source code
warn_roxy_topic Source code
with_collate Source code
work_around_cmark_sourcepos_bug Source code
wrapUsage Source code
wrap_usage Source code
writeLines Source code
write_if_different Source code
write_lines Source code
yaml_path Source code
roxygen2 documentation built on Sept. 9, 2025, 5:23 p.m.

R Package Documentation

rdrr.io home R language documentation Run R code online

Browse R Packages

CRAN packages Bioconductor packages R-Forge packages GitHub packages

We want your feedback!

Note that we can't provide technical support on individual packages. You should contact the package authors for that.
GitHub issue tracker
ian@mutexlabs.com
Personal blog

 
Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.

Close