Knit the Rxs Template

This function knits an Rxs template stored in a parsed Rxs specification, as produced by a call to rxs_fromSpecifications(), into an R Markdown (or Quarto) file.

knit_rxsTemplate(x)

Arguments

x

The object with the Rxs structure as produced by a call to rxs_fromSpecifications().

Value

A character vector with class "knit_asis".

Examples

### Load example Rxs structure
data('rxs_minimal_example_2', package="metabefor");

### Produce the Markdown
knittableMarkdown <-
  knit_rxsTemplate(rxs_minimal_example_2);

### Show the beginning
cat(substr(knittableMarkdown, 1, 2463));
#> 
#> 
#> <pre><textarea rows='40' cols='124' style='font-family:monospace;font-size:11px;white-space:pre;'>```{r rxs-setup-chunk-xr2Epv, echo=FALSE, results='hide'}
#> ```
#> 
#> <!--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->
#> <!--                                                                       -->
#> <!-- Welcome to the R Extraction Script (.rxs.Rmd file) for this source!   -->
#> <!--                                                                       -->
#> <!-- You can now start extracting. If you haven't yet studied the          -->
#> <!-- extractor instructions, please do so first. If you're all set, good   -->
#> <!-- luck!                                                                 -->
#> <!--                                                                       -->
#> <!--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->
#> 
#> ```{r rxs-extraction-chunk, echo=FALSE}
#> ##############################################################################
#> ############################################ START: uniqueSourceIdentifier ###
#> ##############################################################################
#> uniqueSourceIdentifier <- 
#> ##############################################################################
#> ### 
#> ### SET UNIQUE SOURCE IDENTIFIER
#> ### 
#> ### A unique identifier used in this systematic review to refer to this
#> ### source
#> ### 
#> ##############################################################################
#>     
#>     ""
#>     
#> ##############################################################################
#> ########################################### VALUE DESCRIPTION AND EXAMPLES ###
#> ##############################################################################
#> ### 
#> ### A unique identifier to use in this systematic review. For sources
#> ### with a DOI, this is the last part of the shortDOI as looked up
#> ### through https://shortdoi.org (the part after the "10/"). For sources
#> ### without a DOI (and so, without a shortDOI), this can be, for example,
#> ### the QURID (Quasi-Unique Record Identifier) that was designated during
#> ### the screening phase or which you can create with
#> ### `metabefor::qurid()`.
#> ### 
#> ### EXAMPLES:
#> ### 
#> ### "g5fj"
#> ### "qurid_7h4pksl6"
#> ### 
#> ##############################################################################
#> ############################################## END: uniqueSourceIdentifier ###
#> ##############################################################################
#>