Package: protocolhelper 0.6.1

Hans Van Calster

protocolhelper: Helper Functions to Manage Protocols

Helper functions to manage INBO protocols.

Authors:Hans Van Calster [aut, cre], Thierry Onkelinx [aut], Floris Vanderhaeghe [aut], Els Lommelen [ctb], Research Institute for Nature and Forest [cph, fnd]

protocolhelper_0.6.1.tar.gz
protocolhelper_0.6.1.zip(r-4.5)protocolhelper_0.6.1.zip(r-4.4)protocolhelper_0.6.1.zip(r-4.3)
protocolhelper_0.6.1.tgz(r-4.4-any)protocolhelper_0.6.1.tgz(r-4.3-any)
protocolhelper_0.6.1.tar.gz(r-4.5-noble)protocolhelper_0.6.1.tar.gz(r-4.4-noble)
protocolhelper_0.6.1.tgz(r-4.4-emscripten)protocolhelper_0.6.1.tgz(r-4.3-emscripten)
protocolhelper.pdf |protocolhelper.html✨
protocolhelper/json (API)
NEWS

# Install 'protocolhelper' in R:

install.packages('protocolhelper', repos = c('https://inbo.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/inbo/protocolhelper/issues

On CRAN:

30 exports 5 stars 1.08 score 121 dependencies 52 scripts

Last updated 3 days agofrom:2772aa23f8. Checks:OK: 2 ERROR: 5. Indexed: yes.

Target	Result	Date
Doc / Vignettes	OK	Sep 05 2024
R-4.5-win	ERROR	Sep 05 2024
R-4.5-linux	OK	Sep 05 2024
R-4.4-win	ERROR	Sep 05 2024
R-4.4-mac	ERROR	Sep 05 2024
R-4.3-win	ERROR	Sep 05 2024
R-4.3-mac	ERROR	Sep 05 2024

Exports:add_captions add_dependencies add_label add_one_subprotocol add_subprotocols check_all check_all_author_info check_frontmatter check_structure convert_docx_to_rmd create_from_docx create_protocol create_protocol_code create_sap create_sfp create_sip create_sop create_spp get_path_to_protocol get_protocol_type get_protocolnumbers get_short_titles get_version_number increment_version_number insert_protocolsection protocolcheck render_protocol update_protocol update_version_number validate_orcid

Dependencies:askpass assertthat backports base64enc bookdown brew brio bslib cachem callr checklist checkmate cli clipr codemeta codemetar codetools commonmark cpp11 crayon credentials crul curl cyclocomp desc devtools diffobj digest downlit ellipsis evaluate fansi fastmap fontawesome fs gert gh gitcreds glue highr htmltools htmlwidgets httpcode httpuv httr httr2 hunspell ini jquerylib jsonlite knitr later lazyeval lifecycle lintr magrittr memoise mime miniUI openssl pillar pingr pkgbuild pkgconfig pkgdown pkgload praise prettyunits processx profvis promises ps purrr R6 ragg rappdirs rcmdcheck Rcpp reactable reactR rematch2 remotes renv rex rlang rmarkdown roxygen2 rprojroot rstudioapi rversions sass sessioninfo shiny slickR sourcetools stringi stringr sys systemfonts testthat textshaping tibble tinytex triebeard urlchecker urltools usethis utf8 vctrs waldo whisker whoami withr xfun xml2 xmlparsedata xopen xtable yaml ymlthis zip

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Touch up figure and table captions after using 'convert_docx_to_rmd()'	add_captions
Adds dependencies to the YAML of an 'index.Rmd' file	add_dependencies
Helper function to create labelled captions for 'pander' tables	add_label
Helper function to add one sub-protocol to a project-specific protocol of which it is a dependency	add_one_subprotocol
Render all sub-protocols belonging to a main protocol to single markdown files	add_subprotocols
Check protocol 'frontmatter' and 'structure'	check_all
Helper function to check if author information is correct	check_all_author_info
Checks protocol metadata	check_frontmatter
Checks protocol document structure	check_structure
Convert a docx-file (a protocol) to an (R)markdown file	convert_docx_to_rmd
Create a folder with a bookdown (R markdown) template to start a new protocol and optionally render to html	create_protocol create_sap create_sfp create_sip create_sop create_spp
Function to get (or set) the full path to a protocol	get_path_to_protocol
Get protocol type from protocol code	get_protocol_type
Function to list all occupied protocol numbers	get_protocolnumbers
Function to list all short titles that are already in use.	get_short_titles
Get version number for a protocol	get_version_number
Increment version number	increment_version_number
Function to add a chapter or a section of a published protocol for re-use in another protocol	insert_protocolsection
The 'protocolcheck' R6 class	protocolcheck
Function to render a protocol to html and pdf.	render_protocol
Preparatory steps to start the update of a pre-existing version of a protocol	update_protocol
Updates the version number in the YAML section of a protocol 'index.Rmd' file and optionally in protocol 'NEWS.md'	update_version_number
validate an ORCID string	validate_orcid