Package: Rdpack 2.6.9000

Georgi N. Boshnakov

Rdpack: Update and Manipulate Rd Documentation Objects

Functions for manipulation of R documentation objects, including functions reprompt() and ereprompt() for updating 'Rd' documentation for functions, methods and classes; 'Rd' macros for citations and import of references from 'bibtex' files for use in 'Rd' files and 'roxygen2' comments; 'Rd' macros for evaluating and inserting snippets of 'R' code and the results of its evaluation or creating graphics on the fly; and many functions for manipulation of references and Rd files.

Authors:Georgi N. Boshnakov [aut, cre], Duncan Murdoch [ctb]

Rdpack_2.6.9000.tar.gz
Rdpack_2.6.9000.zip(r-4.5)Rdpack_2.6.9000.zip(r-4.4)Rdpack_2.6.9000.zip(r-4.3)
Rdpack_2.6.9000.tgz(r-4.4-any)Rdpack_2.6.9000.tgz(r-4.3-any)
Rdpack_2.6.9000.tar.gz(r-4.5-noble)Rdpack_2.6.9000.tar.gz(r-4.4-noble)
Rdpack_2.6.9000.tgz(r-4.4-emscripten)Rdpack_2.6.9000.tgz(r-4.3-emscripten)
Rdpack.pdf |Rdpack.html✨
Rdpack/json (API)
NEWS

# Install 'Rdpack' in R:
install.packages('Rdpack', repos = c('https://geobosh.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/geobosh/rdpack/issues

On CRAN:

bibtexbibtex-referencescitationsdocumentationrd-formatroxygen2

12.55 score 28 stars 818 packages 92 scripts 93k downloads 1 mentions 98 exports 1 dependencies

Last updated 12 months agofrom:6334cf15fa. Checks:OK: 5 ERROR: 2. Indexed: yes.

TargetResultDate
Doc / VignettesOKNov 02 2024
R-4.5-winERRORNov 02 2024
R-4.5-linuxERRORNov 02 2024
R-4.4-winOKNov 02 2024
R-4.4-macOKNov 02 2024
R-4.3-winOKNov 02 2024
R-4.3-macOKNov 02 2024

Exports:append_to_Rd_listas.character.f_usagec_Rdchar2Rdpiececompare_usage1deparse_usagedeparse_usage1erepromptformat_funusageget_bibentriesget_sig_textget_usageget_usage_textinsert_all_refinsert_citeOnlyinsert_refinspect_argsinspect_clmethodsinspect_Rdinspect_Rdbibinspect_Rdclassinspect_Rdfuninspect_Rdmethodsinspect_signaturesinspect_slotsinspect_usageis_Rdsecnamelist_RdmakeVignetteReferencepairlist2f_usage1parse_1usage_textparse_pairlistparse_Rdnameparse_Rdpieceparse_Rdtextparse_usage_textpromptPackageSexprpromptUsagerattrRd_comboRdapplyRdo_append_argumentRdo_collect_aliasesRdo_commentRdo_drop_emptyRdo_empty_sectionsRdo_fetchRdo_flatinsertRdo_flatremoveRdo_get_argument_namesRdo_get_insert_posRdo_get_item_labelsRdo_insertRdo_insert_elementRdo_is_newlineRdo_itemRdo_locateRdo_locate_core_sectionRdo_locate_leavesRdo_macroRdo_macro1Rdo_macro2Rdo_modifyRdo_modify_simpleRdo_newlineRdo_piece_typesRdo_piecetagRdo_predefined_sectionsRdo_RcodeRdo_remove_srcrefRdo_reparseRdo_replace_sectionRdo_sectionsRdo_sectypeRdo_set_sectionRdo_showRdo_sigitemRdo_tagRdo_tagsRdo_textrdo_text_restorerdo_top_tagsRdo_verbRdo_whichRdo_which_tag_eqRdo_which_tag_inRdo2RdfRdpack_bibstylesRdreplace_sectionRdtagapplyrebibrepromptRStudio_repromptS4formalsset_Rdpack_bibstyleupdate_aliases_tmpviewRdvigbib

Dependencies:rbibutils

Inserting figures and evaluated examples

Rendered fromInserting_figures_and_evaluated_examples.Rnwusingutils::Sweaveon Nov 02 2024.

Last update: 2021-04-24
Started: 2018-06-23

Inserting references in Rd and roxygen2 documentation

Rendered fromInserting_bibtex_references.Rnwusingutils::Sweaveon Nov 02 2024.

Last update: 2022-07-20
Started: 2017-08-16

Readme and manuals

Help Manual

Help pageTopics
Update and Manipulate Rd Documentation ObjectsRdpack-package Rdpack
Add content to the element of an Rd object or fragment at a given positionappend_to_Rd_list
Concatenate Rd objects or piecesc_Rd
Convert a character vector to Rd piecechar2Rdpiece
Compare usage entries for a function to its actual argumentscompare_usage1
Convert f_usage objects to text appropriate for usage sections in Rd filesas.character.f_usage deparse_usage deparse_usage1
Update an Rd file and open it in an editorereprompt
Format the usage text of functionsformat_funusage
Get all references from a Bibtex fileget_bibentries
Produce the textual form of the signatures of available methods for an S4 generic functionget_sig_text
Get the text of the usage section of Rd documentationget_usage_text
Insert references cited in packagesinsert_all_ref
Generate citations from bibtex keysinsert_citeOnly
Insert bibtex references in Rd and roxygen2 documentationinsertRef insert_ref
Inspect the argument section of an Rd objectinspect_args
Inspect and update an Rd object or fileinspect_Rd inspect_Rdclass inspect_Rdfun inspect_Rdmethods
Inspect signatures of S4 methodsinspect_clmethods inspect_signatures
Inspect the slots of an S4 classinspect_slots
Inspect the usage section in an Rd objectinspect_usage
Combine Rd fragmentslist_Rd
Make bibtex references for vignettesmakeVignetteReference vigbib
Parse formal arguments of functionspairlist2f_usage1 parse_pairlist
Parse the name section of an Rd objectparse_Rdname
Parse a piece of Rd source textparse_Rdpiece
Parse Rd source text as the contents of a sectionparse_Rdtext
Parse usage textparse_1usage_text parse_usage_text
Tables of predefined sections and types of pieces of Rd objectsRdo_piece_types Rdo_predefined_sections rdo_top_tags
Generates a shell of documentation for an installed packagepromptPackageSexpr
Generate usage text for functions and methodsget_usage promptUsage
Manipulate a number of Rd filesRd_combo
Apply a function over an Rd objectrattr Rdapply Rdtagapply
Append an item for a new argument to an Rd objectRdo_append_argument
Collect aliases or other metadata from an Rd objectRdo_collect_aliases Rdo_collect_metadata
Find or remove empty sections in Rd objectsRdo_drop_empty Rdo_empty_sections
Get help pages as Rd objectsRdo_fetch
Insert or remove content in an Rd fragmentRdo_flatinsert Rdo_flatremove
Get the names of arguments in usage sections of Rd objectsRdo_get_argument_names
Find the position of an "Rd_tag"Rdo_get_insert_pos
Get the labels of items in an Rd objectRdo_get_item_labels
Insert a new element in an Rd object possibly surrounding it with new linesRdo_insert
Insert a new element in an Rd objectRdo_insert_element
Check if an Rd fragment represents a newline characterRdo_is_newline
Find positions of elements in an Rd objectRdo_locate
Find leaves of an Rd object using a predicateRdo_locate_leaves
Format Rd fragments as macros (todo: a baffling title!)Rdo_item Rdo_macro Rdo_macro1 Rdo_macro2 Rdo_sigitem
Replace or modify parts of Rd objectsRdo_modify Rdo_replace_section
Simple modification of Rd objectsRdo_modify_simple
Give information about Rd elementsis_Rdsecname Rdo_piecetag Rdo_sectype
Remove srcref attributes from Rd objectsRdo_remove_srcref
Reparse an Rd objectRdo_reparse
Locate the sections in Rd objectsRdo_locate_core_section Rdo_sections
Replace a section in an Rd fileRdo_set_section
Convert an Rd object to text and show itRdo_show
Set the Rd_tag of an objectRdo_comment Rdo_newline Rdo_Rcode Rdo_tag Rdo_text Rdo_verb
Give the Rd tags at the top level of an Rd objectRdo_tags
Ensure exported fragments of Rd are as the originalrdo_text_restore
Find elements of Rd objects for which a condition is trueRdo_which Rdo_which_tag_eq Rdo_which_tag_in
Convert an Rd object to Rd file formatRdo2Rdf
Set up a custom style for references in help pagesRdpack_bibstyles
Replace the contents of a section in one or more Rd filesRdreplace_section
Work with bibtex references in Rd documentationinspect_Rdbib rebib
Update the documentation of a topicreprompt
Call reprompt based on RStudio editor contentsRStudio_reprompt
Give the formal arguments of an S4 methodS4formals
Update aliases for methods in Rd objectsupdate_aliases_tmp
View Rd files in a source packageviewRd