add_one_subprotocol: Helper function to add one sub-protocol to a project-specific...

In inbo/protocolshelper: Helper Functions to Manage Protocols

Helper function to add one sub-protocol to a project-specific protocol of which it is a dependency

Description

The function renders the sub-protocol to bookdown::markdown_document2() and saves the resulting md file (and any associated media and data files) in a subfolder of the directory of the project-specific protocol. This function should normally not be called directly. Use add_subprotocols() instead.

Usage

add_one_subprotocol(
  code_subprotocol,
  version_number,
  params2 = NULL,
  code_mainprotocol,
  fetch_remote = TRUE
)

Arguments

code_subprotocol	Character string giving the protocol code from which a sub-protocol will be made (usually a sfp-type protocol)
version_number	Character string with format YYYY.NN
params2	A list of parameter key-value pairs.
code_mainprotocol	Character string giving the protocol code for the main protocol
fetch_remote	Whether or not to fetch the remote. Default TRUE.

See Also

Other creation: add_dependencies(), add_subprotocols(), create_protocol(), insert_protocolsection(), update_protocol(), update_version_number()

Examples

## Not run: 
  add_subprotocols(code_mainprotocol = 'spp-999-en')

## End(Not run)

inbo/protocolshelper documentation built on Sept. 6, 2024, 9:15 p.m.