This function shows the Rxs structure that was imported from an Rxs specification

show_rxsTree_in_rxsStructure(
  x,
  output = NULL,
  outputModuleFilename = "extraction-tree--simple--%s.pdf",
  headingLevel = 3
)

Arguments

x

The parsed Rxs specifications as read with rxs_fromSpecifications().

output, outputModuleFilename

When not NULL, pass a path to a filename where the RxsTree should be written to. If multiple modules were read, the filename is determine by outputModuleFilename, where %s will be replaced with the module name.

headingLevel

The level of the heading to use is multiple modules were specified.

Value

The produced markdown; or, when knitting, an object that knitr will print.

Examples

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

### Show the basic Rxs tree that is specified
### in the Rxs specification
metabefor::show_rxsTree_in_rxsStructure(
  rxs_minimal_example_2
);
#>                                 levelName
#> 1  source                                
#> 2   ¦--general                           
#> 3   ¦   ¦--qurid                         
#> 4   ¦   ¦--language                      
#> 5   ¦   °--sourceAuthors                 
#> 6   ¦       °--sourceAuthor              
#> 7   ¦           ¦--sourceAuthorIdentifier
#> 8   ¦           ¦--sourceAuthorName      
#> 9   ¦           °--sourceAuthorORCID     
#> 10  ¦--methods                           
#> 11  ¦   ¦--sample                        
#> 12  ¦   ¦   ¦--sampleSize                
#> 13  ¦   ¦   °--samplingStrategy          
#> 14  ¦   ¦--method                        
#> 15  ¦   °--variables                     
#> 16  ¦       °--variable                  
#> 17  ¦           ¦--variableIdentifier    
#> 18  ¦           ¦--var_UCID              
#> 19  ¦           °--measurementLevel      
#> 20  °--results                           
#> 21      °--associations                  
#> 22          °--association               
#> 23              ¦--associationIdentifier 
#> 24              ¦--varId1                
#> 25              ¦--varId2                
#> 26              ¦--r                     
#> 27              °--t