doc: fix use of r-path in flowr config (#1255)

flowr-analysis · Jan 22, 2025 · 8514d41 · 8514d41 · github-actions · Jan 22, 2025
1 parent dff9ad6
commit 8514d41
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 31 deletions.
diff --git a/src/config.ts b/src/config.ts
@@ -90,7 +90,6 @@ const defaultEngineConfigs: { [T in EngineConfig['type']]: EngineConfig & { type
 
 export const defaultConfigOptions: FlowrConfigOptions = {
 	ignoreSourceCalls: false,
-	rPath:             undefined,
 	semantics:         {
 		environment: {
 			overwriteBuiltIns: {

diff --git a/src/documentation/print-interface-wiki.ts b/src/documentation/print-interface-wiki.ts
@@ -180,7 +180,6 @@ ${codeBlock('shell', ':query @config')}
 The following summarizes the configuration options:
 
 - \`ignoreSourceCalls\`: If set to \`true\`, _flowR_ will ignore source calls when analyzing the code, i.e., ignoring the inclusion of other files.
-- \`rPath\`: The path to the R executable. If not set, _flowR_ will try to find the R executable in the system's PATH.
 - \`semantics\`: allows to configure the way _flowR_ handles R, although we currently only support \`semantics/environment/overwriteBuiltIns\`. 
   You may use this to overwrite _flowR_'s handling of built-in function and even completely clear the preset definitions shipped with flowR. 
   See [Configure BuiltIn Semantics](#configure-builtin-semantics) for more information.
@@ -197,7 +196,6 @@ So you can configure _flowR_ by adding a file like the following:
 ${codeBlock('json', JSON.stringify(
 		{
 			ignoreSourceCalls: true,
-			rPath:             '/usr/bin/R',
 			semantics:         {
 				environment: {
 					overwriteBuiltIns: {
Benchmark suite	Current: `8514d41`	Previous: `a877df7`	Ratio
`Retrieve AST from R code`	`249.22281477272728` ms (`109.32750823668533`)	`239.49771736363638` ms (`101.48800821636837`)	`1.04`
`Normalize R AST`	`17.032681681818183` ms (`30.11229855232408`)	`17.41336081818182` ms (`30.981566426513265`)	`0.98`
`Produce dataflow information`	`69.29215313636364` ms (`150.09079557366394`)	`68.728513` ms (`151.94316854576633`)	`1.01`
`Total per-file`	`854.6366423636364` ms (`1560.3060821041117`)	`837.9476761818181` ms (`1510.9729062977526`)	`1.02`
`Static slicing`	`1.97687370570448` ms (`1.0948918272944028`)	`2.0034774339582415` ms (`1.1691051705207822`)	`0.99`
`Reconstruct code`	`0.2265680834900549` ms (`0.17680382782808918`)	`0.22634653062782062` ms (`0.168666676054442`)	`1.00`
`Total per-slice`	`2.217877556844418` ms (`1.1720883904337962`)	`2.24374443748002` ms (`1.2384172691894533`)	`0.99`
`failed to reconstruct/re-parse`	`0` #	`0` #	`1`
`times hit threshold`	`0` #	`0` #	`1`
`reduction (characters)`	`0.7891949660994808` #	`0.7891949660994808` #	`1`
`reduction (normalized tokens)`	`0.7665650684287274` #	`0.7665650684287274` #	`1`
`memory (df-graph)`	`95.19682173295455` KiB (`244.24808975931026`)	`95.19682173295455` KiB (`244.24808975931026`)	`1`
Benchmark suite	Current: `8514d41`	Previous: `a877df7`	Ratio
`Retrieve AST from R code`	`241.3553934` ms (`44.08192434192751`)	`240.34012847999998` ms (`43.93673078226616`)	`1.00`
`Normalize R AST`	`18.30161434` ms (`13.726966001011917`)	`18.87248132` ms (`14.186278380523435`)	`0.97`
`Produce dataflow information`	`77.3114396` ms (`72.78663425633144`)	`78.15406248000001` ms (`73.48454316898545`)	`0.99`
`Total per-file`	`7462.413609939999` ms (`29283.468073190135`)	`7582.25710378` ms (`29767.39189439267`)	`0.98`
`Static slicing`	`15.043143218924847` ms (`44.252695284178856`)	`15.270449566508105` ms (`44.94967789767313`)	`0.99`
`Reconstruct code`	`0.24633282945769822` ms (`0.1517546138689776`)	`0.2585950662014173` ms (`0.1532502183629028`)	`0.95`
`Total per-slice`	`15.297064814879313` ms (`44.294932628854106`)	`15.537331197364793` ms (`44.98374295831238`)	`0.98`
`failed to reconstruct/re-parse`	`0` #	`0` #	`1`
`times hit threshold`	`0` #	`0` #	`1`
`reduction (characters)`	`0.8760481407790371` #	`0.8760481407790371` #	`1`
`reduction (normalized tokens)`	`0.8152466834674152` #	`0.8152466834674152` #	`1`
`memory (df-graph)`	`99.6448046875` KiB (`113.2159841674677`)	`99.6448046875` KiB (`113.2159841674677`)	`1`
Benchmark suite	Current: `8514d41`	Previous: `a877df7`	Ratio
`Retrieve AST from R code`	`7.571988090909091` ms (`9.157146751998651`)	`8.145506545454547` ms (`9.786080094734778`)	`0.93`
`Normalize R AST`	`17.612633318181818` ms (`23.043740367693804`)	`17.78099590909091` ms (`23.820712056308647`)	`0.99`
`Produce dataflow information`	`69.0156630909091` ms (`143.35894512894018`)	`70.83680254545455` ms (`150.5207252208632`)	`0.97`
`Total per-file`	`606.9355683636363` ms (`1392.6532912532095`)	`627.2099676818182` ms (`1407.4477264884629`)	`0.97`
`Static slicing`	`1.9768534768927744` ms (`1.0989062396021616`)	`2.0248883955065318` ms (`1.1173257361688766`)	`0.98`
`Reconstruct code`	`0.22369064854003748` ms (`0.1717429586862442`)	`0.23812396339689798` ms (`0.1785232875956438`)	`0.94`
`Total per-slice`	`2.2130764744675138` ms (`1.1712200979728884`)	`2.2780515267109083` ms (`1.198556469122308`)	`0.97`
`failed to reconstruct/re-parse`	`0` #	`0` #	`1`
`times hit threshold`	`0` #	`0` #	`1`
`reduction (characters)`	`0.7891949660994808` #	`0.7891949660994808` #	`1`
`reduction (normalized tokens)`	`0.7665650684287274` #	`0.7665650684287274` #	`1`
`memory (df-graph)`	`95.19682173295455` KiB (`244.24808975931026`)	`95.19682173295455` KiB (`244.24808975931026`)	`1`
Benchmark suite	Current: `8514d41`	Previous: `a877df7`	Ratio
`Retrieve AST from R code`	`10.18284891111111` ms (`6.352175159664852`)	`10.4682258` ms (`6.536909762375299`)	`0.97`
`Normalize R AST`	`23.809620155555553` ms (`11.587752850383934`)	`23.515930466666664` ms (`11.460003796895084`)	`1.01`
`Produce dataflow information`	`77.61215491111112` ms (`65.45823893173034`)	`77.72576402222222` ms (`66.68368526289126`)	`1.00`
`Total per-file`	`7584.554670244444` ms (`30979.6920932443`)	`7557.427238355555` ms (`30739.010883053157`)	`1.00`
`Static slicing`	`15.864625312807254` ms (`46.03669692169887`)	`15.83153546219062` ms (`45.672079288893144`)	`1.00`
`Reconstruct code`	`0.26252327837383055` ms (`0.16256092894538607`)	`0.2510293465879067` ms (`0.15539877495324173`)	`1.05`
`Total per-slice`	`16.134979333093334` ms (`46.07635486204849`)	`16.090141405670494` ms (`45.71466701697095`)	`1.00`
`failed to reconstruct/re-parse`	`0` #	`0` #	`1`
`times hit threshold`	`0` #	`0` #	`1`
`reduction (characters)`	`0.8685107303274813` #	`0.8685107303274813` #	`1`
`reduction (normalized tokens)`	`0.8049905198879769` #	`0.8049905198879769` #	`1`
`memory (df-graph)`	`97.50590277777778` KiB (`111.14577334743846`)	`97.50590277777778` KiB (`111.14577334743846`)	`1`