R: Update and Manipulate Rd Documentation Objects

# Update and Manipulate Rd Documentation Objects

## Documentation for package ‘Rdpack’ version 2.6.4

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A C D E F G I L M P R S U V

Rdpack-package | Update and Manipulate Rd Documentation Objects

## -- A --

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

## -- C --

char2Rdpiece | Convert a character vector to Rd piece
compare_usage1 | Compare usage entries for a function to its actual arguments
c_Rd | Concatenate Rd objects or pieces

## -- D --

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

## -- E --

ereprompt | Update an Rd file and open it in an editor

## -- F --

format_funusage | Format the usage text of functions

## -- G --

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 | Generate usage text for functions and methods
get_usage_text | Get the text of the usage section of Rd documentation

## -- I --

insertRef | Insert bibtex references in Rd and roxygen2 documentation
insert_all_ref | Insert references cited in packages
insert_citeOnly | Generate citations from bibtex keys
insert_ref | Insert bibtex references in Rd and roxygen2 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

## -- L --

list_Rd | Combine Rd fragments

## -- M --

makeVignetteReference | Make bibtex references for vignettes

## -- P --

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_usage_text | Parse usage text
promptPackageSexpr | Generates a shell of documentation for an installed package
promptUsage | Generate usage text for functions and methods

## -- R --

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_fetch | Get help pages as Rd objects
Rdo_flatinsert | Insert or remove content in an Rd fragment
Rdo_flatremove | Insert or remove 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 | Get the labels of items in an Rd object
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 | Ensure exported fragments of Rd are as the original
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
Rdpack_bibstyles | Set up a custom style for references in help pages
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
RStudio_reprompt | Call reprompt based on RStudio editor contents

## -- S --

S4formals | Give the formal arguments of an S4 method

## -- U --

update_aliases_tmp | Update aliases for methods in Rd objects

## -- V --

viewRd | View Rd files in a source package
vigbib | Make bibtex references for vignettes