Learn R Programming

⚠️There's a newer version (2.6.4) of this package.Take me there.

Rdpack (version 0.4-20)

Update and Manipulate Rd Documentation Objects

Description

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.

Copy Link

Version

Install

install.packages('Rdpack')

Monthly Downloads

433,318

Version

0.4-20

License

GPL (>= 2)

Maintainer

Georgi Boshnakov

Last Published

July 26th, 2016

Functions in Rdpack (0.4-20)

Convert f_usage objects to text appropriate for usage sections in Rd files

Get the text of the usage section of Rd documentation

Produce the textual form of the signatures of available methods for an S4 generic function

format_funusage

Format the usage text of functions

append_to_Rd_list

Add content to the element of an Rd object or fragment at a given position

Give the key associated with a bibentry element

Get all references from a Bibtex file

Concatenate Rd objects or pieces

Compare usage entries for a function

Convert a character vector to Rd piece

Parse formal arguments of functions

Inspect the slots of an S4 class

inspect_signatures

Inspect signatures of S4 methods

Combine Rd fragments

Inspect and update an Rd object or file

Insert bibtex references in Rd and roxygen documentation

Inspect the usage section in an Rd object

Inspect the argument section of an Rd object

Parse the name section of an Rd object

Parse a piece of Rd source text

Usage text for a function, S3 method or S4 method

Manipulate a number of Rd files

parse_usage_text

Parse usage text

Rdo_remove_srcref

Remove srcref attributes from Rd objects

Parse expressions residing in character vectors

Apply a function over an Rd object

Rdo_append_argument

Append an item for a new argument to an Rd object

promptPackageSexpr

Generates a shell of documentation for an installed package

Parse Rd source text as the contents of a section

Rdo_collect_metadata

Collect aliases or other metadata from an Rd object

Rdo_get_item_labels

~~ Dummy title ~~

Rdo_locate_leaves

Find leaves of an Rd object using a predicate

Find positions of elements in an Rd object

Rdo_insert_element

Insert a new element in an Rd object

Rdo_get_insert_pos

Find the position of an "Rd_tag"

Insert content in an Rd fragment

Rdo_empty_sections

Find or remove empty sections in Rd objects

Rdo_get_argument_names

Get the names of arguments in usage sections of Rd objects

Insert a new element in an Rd object possibly surrounding it with new lines

Check if an Rd fragment represents a newline character

Convert an Rd object to text and show it

Format Rd fragments as macros (todo: a baffling title!)

Rdo_set_section

Replace a section in an Rd file

Work with bibtex references in Rd documentation

Rdo_modify_simple

Simple modification of Rd objects

Update the documentation of a topic

Set the Rd_tag of an object

Give information about Rd elements

Replace or modify parts of Rd objects

Give the Rd tags at the top level of an Rd object

.capture_promptAny

Internal functions used by reprompt

update_aliases_tmp

Update aliases for methods in Rd objects

Give the formal arguments of an S4 method

Find elements of Rd objects for which a condition is true

rdo_text_restore

~~ Dummy title ~~

Reparse an Rd object

Convert an Rd object to Rd file format

Tensor comparison and asymmetric comparison between two vectors

Locate the sections in Rd objects

Rdreplace_section

Replace the contents of a section in one or more Rd files

Escape backslashes and percent in Rd code