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'))

Peer review:

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

Pkgdown:https://inbo.github.io

On CRAN:

3.92 score 5 stars 55 scripts 30 exports 120 dependencies

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

TargetResultDate
Doc / VignettesOKDec 04 2024
R-4.5-winERRORDec 04 2024
R-4.5-linuxOKDec 04 2024
R-4.4-winERRORDec 04 2024
R-4.4-macERRORDec 04 2024
R-4.3-winERRORDec 04 2024
R-4.3-macERRORDec 04 2024

Exports:add_captionsadd_dependenciesadd_labeladd_one_subprotocoladd_subprotocolscheck_allcheck_all_author_infocheck_frontmattercheck_structureconvert_docx_to_rmdcreate_from_docxcreate_protocolcreate_protocol_codecreate_sapcreate_sfpcreate_sipcreate_sopcreate_sppget_path_to_protocolget_protocol_typeget_protocolnumbersget_short_titlesget_version_numberincrement_version_numberinsert_protocolsectionprotocolcheckrender_protocolupdate_protocolupdate_version_numbervalidate_orcid

Dependencies:askpassassertthatbackportsbase64encbookdownbrewbriobslibcachemcallrchecklistcheckmateclicliprcodemetacodemetarcodetoolscommonmarkcpp11crayoncredentialscrulcurlcyclocompdescdevtoolsdiffobjdigestdownlitellipsisevaluatefansifastmapfontawesomefsgertghgitcredsgluehighrhtmltoolshtmlwidgetshttpcodehttpuvhttrhttr2hunspellinijquerylibjsonliteknitrlaterlazyevallifecyclelintrmagrittrmemoisemimeminiUIopensslpillarpingrpkgbuildpkgconfigpkgdownpkgloadpraiseprettyunitsprocessxprofvispromisespspurrrR6raggrappdirsrcmdcheckRcppreactablereactRremotesrenvrexrlangrmarkdownroxygen2rprojrootrstudioapirversionssasssessioninfoshinyslickRsourcetoolsstringistringrsyssystemfontstestthattextshapingtibbletinytextriebeardurlcheckerurltoolsusethisutf8vctrswaldowhiskerwhoamiwithrxfunxml2xmlparsedataxopenxtableyamlymlthiszip

Readme and manuals

Help Manual

Help pageTopics
Touch up figure and table captions after using 'convert_docx_to_rmd()'add_captions
Adds dependencies to the YAML of an 'index.Rmd' fileadd_dependencies
Helper function to create labelled captions for 'pander' tablesadd_label
Helper function to add one sub-protocol to a project-specific protocol of which it is a dependencyadd_one_subprotocol
Render all sub-protocols belonging to a main protocol to single markdown filesadd_subprotocols
Check protocol 'frontmatter' and 'structure'check_all
Helper function to check if author information is correctcheck_all_author_info
Checks protocol metadatacheck_frontmatter
Checks protocol document structurecheck_structure
Convert a docx-file (a protocol) to an (R)markdown fileconvert_docx_to_rmd
Create a folder with a bookdown (R markdown) template to start a new protocol and optionally render to htmlcreate_protocol create_sap create_sfp create_sip create_sop create_spp
Function to get (or set) the full path to a protocolget_path_to_protocol
Get protocol type from protocol codeget_protocol_type
Function to list all occupied protocol numbersget_protocolnumbers
Function to list all short titles that are already in use.get_short_titles
Get version number for a protocolget_version_number
Increment version numberincrement_version_number
Function to add a chapter or a section of a published protocol for re-use in another protocolinsert_protocolsection
The 'protocolcheck' R6 classprotocolcheck
Function to render a protocol to html and pdf.render_protocol
Preparatory steps to start the update of a pre-existing version of a protocolupdate_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 stringvalidate_orcid