Rdpack: Update and Manipulate Rd Documentation Objects
Version 0.4-20

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.

Browse man pages Browse package API and functions Browse package files

AuthorGeorgi N. Boshnakov
Date of publication2016-07-26 22:49:56
MaintainerGeorgi N. Boshnakov <georgi.boshnakov@manchester.ac.uk>
LicenseGPL (>= 2)
Version0.4-20
Package repositoryView on CRAN
InstallationInstall the latest version of this package by entering the following in R:
install.packages("Rdpack")

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

Functions

.anypercent Man page
.asym_compare Man page
.bsdup Man page
.bspercent Man page
.capture_installed_help Man page
.capture_promptAny Man page
.ocompare Man page
Rd_combo Man page Source code
Rd_tidy Source code
Rdapply Man page Source code
Rdinter Source code
Rdo2Rdf Man page Source code
Rdo_Rcode Man page Source code
Rdo_append_argument Man page Source code
Rdo_collect_aliases Man page Source code
Rdo_collect_metadata Man page Source code
Rdo_comment Man page Source code
Rdo_drop_empty Man page Source code
Rdo_elem Source code
Rdo_empty_sections Man page Source code
Rdo_flatinsert Man page Source code
Rdo_flatremove Man page Source code
Rdo_get_argument_names Man page Source code
Rdo_get_insert_pos Man page Source code
Rdo_get_item_labels Man page Source code
Rdo_insert Man page Source code
Rdo_insert_element Man page Source code
Rdo_is_newline Man page Source code
Rdo_item Man page Source code
Rdo_locate Man page Source code
Rdo_locate_core_section Man page Source code
Rdo_locate_leaves Man page Source code
Rdo_macro Man page Source code
Rdo_macro1 Man page Source code
Rdo_macro2 Man page Source code
Rdo_modify Man page Source code
Rdo_modify_simple Man page Source code
Rdo_newline Man page Source code
Rdo_piecetag Man page Source code
Rdo_remove_srcref Man page Source code
Rdo_reparse Man page Source code
Rdo_replace_section Man page Source code
Rdo_sections Man page Source code
Rdo_sectype Man page Source code
Rdo_set_section Man page Source code
Rdo_show Man page Source code
Rdo_sigitem Man page Source code
Rdo_tag Man page Source code
Rdo_tags Man page Source code
Rdo_text Man page Source code
Rdo_verb Man page Source code
Rdo_which Man page Source code
Rdo_which_tag_eq Man page Source code
Rdo_which_tag_in Man page Source code
Rdreplace_section Man page Source code
Rdtagapply Man page Source code
S4formals Man page Source code
anypercent Source code
append_to_Rd_list Man page Source code
as.character.f_usage Man page Source code
ascharRd Source code
asym_compare Source code
aux_Rdo_locate_leaves Source code
bibentry_key Man page Source code
bs2 Source code
bspercent Source code
c_Rd Man page Source code
capture_installed_help Source code
capture_promptAny Source code
char2Rdpiece Man page Source code
char2Rdtag Source code
compare_usage1 Man page Source code
deparse_usage Man page Source code
deparse_usage1 Man page Source code
esc_br Source code
escape_bs_in_Rcode Source code
format_funusage Man page Source code
get.name_content Source code
get_bibentries Man page Source code
get_item_label Source code
get_item_labsig Source code
get_sig_text Man page Source code
get_signature Source code
get_subset Source code
get_top_items Source code
get_top_labels Source code
get_top_signature Source code
get_usage Man page Source code
get_usage_text Man page Source code
insertRef Man page
insert_ref Man page Source code
inspect_Rd Man page Source code
inspect_Rdbib Man page Source code
inspect_Rdclass Man page Source code
inspect_Rdfun Man page Source code
inspect_Rdmethods Man page Source code
inspect_args Man page Source code
inspect_clmethods Man page Source code
inspect_signatures Man page Source code
inspect_slots Man page Source code
inspect_usage Man page Source code
is_Rdsecname Man page Source code
list_Rd Man page Source code
locate_enclosing_tag Source code
locate_sec_content Source code
locate_top_items Source code
locate_top_tag Source code
make_named Source code
merge_pos Source code
merge_pos0 Source code
methsig2alias Source code
nl_and_indent Source code
notFALSE Source code
notTRUE Source code
ocompare Source code
order_sections Source code
pairlist2f_usage Man page
pairlist2f_usage1 Man page Source code
parse_1usage_text Man page Source code
parse_Rdlines Source code
parse_Rdname Man page Source code
parse_Rdpiece Man page Source code
parse_Rdtext Man page Source code
parse_long_name Source code
parse_pairlist Man page Source code
parse_text Man page Source code
parse_usage_text Man page Source code
patch_latex Source code
pos_in_eqnpos Source code
promptPackageSexpr Man page Source code
promptUsage Man page Source code
rattr Man page Source code
rdo_equal_sections Source code
rdo_replace_at Source code
rdo_srcref Source code
rdo_text_restore Man page Source code
rebib Man page Source code
replace_dummy Source code
replace_from Source code
reprompt Man page Source code
safeRdtag Source code
sec_content Source code
sec_name Source code
srcrefpos Source code
strip_whitespace Source code
tag_eq Source code
tag_in Source code
tmp_pos Source code
toolsdotdotdot.Rd_drop_nodes_with_tags Source code
toolsdotdotdot.Rd_get_metadata Source code
toolsdotdotdotfetchRdDB Source code
update_aliases_tmp Man page Source code
utilsdotdotdot.getHelpFile Source code
without_duplicates Source code

Files

inst
inst/REFERENCES.bib
inst/auto
inst/auto/REFERENCES.el
inst/doc
inst/doc/Inserting_bibtex_references.pdf
inst/doc/Inserting_bibtex_references.Rnw
NAMESPACE
NEWS
R
R/sections.R
R/zzobsolete.R
R/utils.R
R/inspect.R
R/manip.R
R/signature.R
R/usage.R
R/threedots.R
R/slots.R
R/yytransient.R
R/parse.R
R/bib.R
R/repromptAny.R
R/promptSexpr.R
R/predefined.R
R/elements.R
R/Rdo2Rdf.R
R/alias.R
R/f_usage.R
vignettes
vignettes/Inserting_bibtex_references.Rnw
MD5
build
build/vignette.rds
build/partial.rdb
DESCRIPTION
man
man/promptUsage.Rd
man/Rdo_locate_leaves.Rd
man/Rdo_sections.Rd
man/Rdo_is_newline.Rd
man/Rdo2Rdf.Rd
man/parse_usage_text.Rd
man/char2Rdpiece.Rd
man/get_sig_text.Rd
man/Rdo_which.Rd
man/Rdo_tag.Rd
man/append_to_Rd_list.Rd
man/Rdo_show.Rd
man/parse_Rdname.Rd
man/reprompt.Rd
man/Rdo_macro.Rd
man/Rdo_empty_sections.Rd
man/zzcapture_promptany.Rd
man/bibentry_key.Rd
man/S4formals.Rd
man/rdo_text_restore.Rd
man/Rdo_tags.Rd
man/predefined.Rd
man/inspect_usage.Rd
man/Rdo_append_argument.Rd
man/Rdo_get_insert_pos.Rd
man/parse_text.Rd
man/rebib.Rd
man/zzasym_compare.Rd
man/format_funusage.Rd
man/Rdo_flatinsert.Rd
man/Rdo_insert.Rd
man/Rdo_collect_metadata.Rd
man/inspect_args.Rd
man/get_bibentries.Rd
man/Rd_combo.Rd
man/Rdpack-package.Rd
man/Rdo_get_argument_names.Rd
man/deparse_usage.Rd
man/Rdo_get_item_labels.Rd
man/Rdo_modify.Rd
man/parse_Rdtext.Rd
man/c_Rd.Rd
man/Rdapply.Rd
man/parse_pairlist.Rd
man/inspect_signatures.Rd
man/insert_ref.Rd
man/compare_usage1.Rd
man/Rdo_set_section.Rd
man/update_aliases_tmp.Rd
man/macros
man/macros/refmacros.Rd
man/Rdo_insert_element.Rd
man/promptPackageSexpr.Rd
man/Rdo_locate.Rd
man/Rdo_piecetag.Rd
man/list_Rd.Rd
man/inspect_slots.Rd
man/zzbsdup.Rd
man/Rdo_modify_simple.Rd
man/parse_Rdpiece.Rd
man/inspect_Rd.Rd
man/get_usage_text.Rd
man/Rdo_reparse.Rd
man/Rd_remove_srcref.Rd
man/Rdreplace_section.Rd
Rdpack documentation built on May 19, 2017, 10:33 a.m.