Rdpack: Update and Manipulate Rd Documentation Objects

Functions for manipulation of Rd objects, including function reprompt() for updating existing Rd documentation for functions, methods and classes and function rebib() for import of references from 'bibtex' files. There is also a macro for importing 'bibtex' references which an be used in Rd files and 'roxygen' comments without importing this package.

AuthorGeorgi N. Boshnakov
Date of publication2016-07-26 22:49:56
MaintainerGeorgi N. Boshnakov <georgi.boshnakov@manchester.ac.uk>
LicenseGPL (>= 2)

View on CRAN

Man pages

append_to_Rd_list: Add content to the element of an Rd object or fragment at a...

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...

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...

get_usage_text: Get the text of the usage section of Rd documentation

insert_ref: Insert bibtex references in Rd and roxygen documentation

inspect_args: Inspect the argument section of an Rd object

inspect_Rd: 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

list_Rd: Combine Rd fragments

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

Rdapply: Apply a function over an Rd object

Rd_combo: Manipulate a number of Rd files

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_metadata: Collect aliases or other metadata from an Rd object

Rdo_empty_sections: Find or remove empty sections in Rd objects

Rdo_flatinsert: 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...

Rdo_insert_element: Insert a new element in an Rd object

Rdo_is_newline: Check if an Rd fragment represents a newline character

Rdo_locate: Find positions of elements in an Rd object

Rdo_locate_leaves: Find leaves of an Rd object using a predicate

Rdo_macro: 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_piecetag: Give information about Rd elements

Rdo_reparse: Reparse an Rd object

Rdo_sections: Locate the sections in Rd objects

Rdo_set_section: Replace a section in an Rd file

Rdo_show: Convert an Rd object to text and show it

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_restore: ~~ Dummy title ~~

Rdo_which: Find elements of Rd objects for which a condition is true

Rd_remove_srcref: Remove srcref attributes from Rd objects

Rdreplace_section: Replace the contents of a section in one or more 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

zzasym_compare: Tensor comparison and asymmetric comparison between two...

zzbsdup: Escape backslashes and percent in Rd code

zzcapture_promptany: Internal functions used by reprompt

Files in this package

Rdpack/R/sections.R Rdpack/R/zzobsolete.R Rdpack/R/utils.R Rdpack/R/inspect.R Rdpack/R/manip.R Rdpack/R/signature.R Rdpack/R/usage.R Rdpack/R/threedots.R Rdpack/R/slots.R Rdpack/R/yytransient.R Rdpack/R/parse.R Rdpack/R/bib.R Rdpack/R/repromptAny.R Rdpack/R/promptSexpr.R Rdpack/R/predefined.R Rdpack/R/elements.R Rdpack/R/Rdo2Rdf.R Rdpack/R/alias.R Rdpack/R/f_usage.R
Rdpack/man/promptUsage.Rd Rdpack/man/Rdo_locate_leaves.Rd Rdpack/man/Rdo_sections.Rd Rdpack/man/Rdo_is_newline.Rd Rdpack/man/Rdo2Rdf.Rd Rdpack/man/parse_usage_text.Rd Rdpack/man/char2Rdpiece.Rd Rdpack/man/get_sig_text.Rd Rdpack/man/Rdo_which.Rd Rdpack/man/Rdo_tag.Rd Rdpack/man/append_to_Rd_list.Rd Rdpack/man/Rdo_show.Rd Rdpack/man/parse_Rdname.Rd Rdpack/man/reprompt.Rd Rdpack/man/Rdo_macro.Rd Rdpack/man/Rdo_empty_sections.Rd Rdpack/man/zzcapture_promptany.Rd Rdpack/man/bibentry_key.Rd Rdpack/man/S4formals.Rd Rdpack/man/rdo_text_restore.Rd Rdpack/man/Rdo_tags.Rd
Rdpack/man/inspect_usage.Rd Rdpack/man/Rdo_append_argument.Rd Rdpack/man/Rdo_get_insert_pos.Rd Rdpack/man/parse_text.Rd Rdpack/man/rebib.Rd Rdpack/man/zzasym_compare.Rd Rdpack/man/format_funusage.Rd Rdpack/man/Rdo_flatinsert.Rd Rdpack/man/Rdo_insert.Rd Rdpack/man/Rdo_collect_metadata.Rd Rdpack/man/inspect_args.Rd Rdpack/man/get_bibentries.Rd Rdpack/man/Rd_combo.Rd
Rdpack/man/Rdo_get_argument_names.Rd Rdpack/man/deparse_usage.Rd Rdpack/man/Rdo_get_item_labels.Rd Rdpack/man/Rdo_modify.Rd Rdpack/man/parse_Rdtext.Rd Rdpack/man/c_Rd.Rd Rdpack/man/Rdapply.Rd Rdpack/man/parse_pairlist.Rd Rdpack/man/inspect_signatures.Rd Rdpack/man/insert_ref.Rd Rdpack/man/compare_usage1.Rd Rdpack/man/Rdo_set_section.Rd Rdpack/man/update_aliases_tmp.Rd
Rdpack/man/Rdo_insert_element.Rd Rdpack/man/promptPackageSexpr.Rd Rdpack/man/Rdo_locate.Rd Rdpack/man/Rdo_piecetag.Rd Rdpack/man/list_Rd.Rd Rdpack/man/inspect_slots.Rd Rdpack/man/zzbsdup.Rd Rdpack/man/Rdo_modify_simple.Rd Rdpack/man/parse_Rdpiece.Rd Rdpack/man/inspect_Rd.Rd Rdpack/man/get_usage_text.Rd Rdpack/man/Rdo_reparse.Rd Rdpack/man/Rd_remove_srcref.Rd Rdpack/man/Rdreplace_section.Rd

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

All documentation is copyright its authors; we didn't write any of that.