Update and Manipulate Rd Documentation Objects


[Up] [Top]

Documentation for package ‘Rdpack’ version 0.4-20

Help Pages

Rdpack-package Update and Manipulate Rd Documentation Objects
append_to_Rd_list Add content to the element of an Rd object or fragment at a given position
as.character.f_usage Convert f_usage objects to text appropriate for usage sections in Rd files
bibentry_key Give the key associated with a bibentry element
char2Rdpiece Convert a character vector to Rd piece
compare_usage1 Compare usage entries for a function
c_Rd Concatenate Rd objects or pieces
deparse_usage Convert f_usage objects to text appropriate for usage sections in Rd files
deparse_usage1 Convert f_usage objects to text appropriate for usage sections in Rd files
format_funusage Format the usage text of functions
get_bibentries Get all references from a Bibtex file
get_sig_text Produce the textual form of the signatures of available methods for an S4 generic function
get_usage Usage text for a function, S3 method or S4 method
get_usage_text Get the text of the usage section of Rd documentation
insertRef Insert bibtex references in Rd and roxygen documentation
insert_ref Insert bibtex references in Rd and roxygen documentation
inspect_args Inspect the argument section of an Rd object
inspect_clmethods Inspect signatures of S4 methods
inspect_Rd Inspect and update an Rd object or file
inspect_Rdbib Work with bibtex references in Rd documentation
inspect_Rdclass Inspect and update an Rd object or file
inspect_Rdfun Inspect and update an Rd object or file
inspect_Rdmethods Inspect and update an Rd object or file
inspect_signatures Inspect signatures of S4 methods
inspect_slots Inspect the slots of an S4 class
inspect_usage Inspect the usage section in an Rd object
is_Rdsecname Give information about Rd elements
list_Rd Combine Rd fragments
pairlist2f_usage Parse formal arguments of functions
pairlist2f_usage1 Parse formal arguments of functions
parse_1usage_text Parse usage text
parse_pairlist Parse formal arguments of functions
parse_Rdname Parse the name section of an Rd object
parse_Rdpiece Parse a piece of Rd source text
parse_Rdtext Parse Rd source text as the contents of a section
parse_text Parse expressions residing in character vectors
parse_usage_text Parse usage text
promptPackageSexpr Generates a shell of documentation for an installed package
promptUsage Usage text for a function, S3 method or S4 method
rattr Apply a function over an Rd object
Rdapply Apply a function over an Rd object
Rdo2Rdf Convert an Rd object to Rd file format
Rdo_append_argument Append an item for a new argument to an Rd object
Rdo_collect_aliases Collect aliases or other metadata from an Rd object
Rdo_collect_metadata Collect aliases or other metadata from an Rd object
Rdo_comment Set the Rd_tag of an object
Rdo_drop_empty Find or remove empty sections in Rd objects
Rdo_empty_sections Find or remove empty sections in Rd objects
Rdo_flatinsert Insert content in an Rd fragment
Rdo_flatremove Insert content in an Rd fragment
Rdo_get_argument_names Get the names of arguments in usage sections of Rd objects
Rdo_get_insert_pos Find the position of an "Rd_tag"
Rdo_get_item_labels ~~ Dummy title ~~
Rdo_insert Insert a new element in an Rd object possibly surrounding it with new lines
Rdo_insert_element Insert a new element in an Rd object
Rdo_is_newline Check if an Rd fragment represents a newline character
Rdo_item Format Rd fragments as macros (todo: a baffling title!)
Rdo_locate Find positions of elements in an Rd object
Rdo_locate_core_section Locate the sections in Rd objects
Rdo_locate_leaves Find leaves of an Rd object using a predicate
Rdo_macro Format Rd fragments as macros (todo: a baffling title!)
Rdo_macro1 Format Rd fragments as macros (todo: a baffling title!)
Rdo_macro2 Format Rd fragments as macros (todo: a baffling title!)
Rdo_modify Replace or modify parts of Rd objects
Rdo_modify_simple Simple modification of Rd objects
Rdo_newline Set the Rd_tag of an object
Rdo_piecetag Give information about Rd elements
Rdo_piece_types Tables of predefined sections and types of pieces of Rd objects
Rdo_predefined_sections Tables of predefined sections and types of pieces of Rd objects
Rdo_Rcode Set the Rd_tag of an object
Rdo_remove_srcref Remove srcref attributes from Rd objects
Rdo_reparse Reparse an Rd object
Rdo_replace_section Replace or modify parts of Rd objects
Rdo_sections Locate the sections in Rd objects
Rdo_sectype Give information about Rd elements
Rdo_set_section Replace a section in an Rd file
Rdo_show Convert an Rd object to text and show it
Rdo_sigitem Format Rd fragments as macros (todo: a baffling title!)
Rdo_tag Set the Rd_tag of an object
Rdo_tags Give the Rd tags at the top level of an Rd object
Rdo_text Set the Rd_tag of an object
rdo_text_restore ~~ Dummy title ~~
rdo_top_tags Tables of predefined sections and types of pieces of Rd objects
Rdo_verb Set the Rd_tag of an object
Rdo_which Find elements of Rd objects for which a condition is true
Rdo_which_tag_eq Find elements of Rd objects for which a condition is true
Rdo_which_tag_in Find elements of Rd objects for which a condition is true
Rdpack Update and Manipulate Rd Documentation Objects
Rdreplace_section Replace the contents of a section in one or more Rd files
Rdtagapply Apply a function over an Rd object
Rd_combo Manipulate a number of Rd files
rebib Work with bibtex references in Rd documentation
reprompt Update the documentation of a topic
S4formals Give the formal arguments of an S4 method
update_aliases_tmp Update aliases for methods in Rd objects