@eagleoutice/flowr 2.6.1 → 2.6.2

package/statistics/features/common-syntax-probability.d.ts

@@ -1,4 +1,4 @@
-import type { SummarizedMeasurement } from '../../util/summarizer';
+import { type SummarizedMeasurement } from '../../util/summarizer';
 import { RFalse, RTrue } from '../../r-bridge/lang-4.x/convert-values';
 import type { RArgument } from '../../r-bridge/lang-4.x/ast/model/nodes/r-argument';
 import type { RNode } from '../../r-bridge/lang-4.x/ast/model/model';
@@ -20,10 +20,19 @@ export interface CommonSyntaxTypeCounts<Measurement = bigint> {
     unaryOp: Record<string, Measurement>;
     other: Record<string, Measurement>;
 }
+/**
+ *
+ */
 export declare function emptyCommonSyntaxTypeCounts<T = bigint>(init?: () => T): CommonSyntaxTypeCounts<T>;
 /**
  * Updates the given counts based on the type of the given node.
  */
 export declare function updateCommonSyntaxTypeCounts(current: CommonSyntaxTypeCounts, ...nodes: (RNode | RArgument)[]): CommonSyntaxTypeCounts;
+/**
+ *
+ */
 export declare function appendCommonSyntaxTypeCounter(a: CommonSyntaxTypeCounts<number[][]>, b: CommonSyntaxTypeCounts): void;
+/**
+ *
+ */
 export declare function summarizeCommonSyntaxTypeCounter(a: CommonSyntaxTypeCounts<number[][]>): CommonSyntaxTypeCounts<SummarizedMeasurement>;

package/statistics/features/common-syntax-probability.js

@@ -11,6 +11,9 @@ const numbers_1 = require("../../util/numbers");
 const summarizer_1 = require("../../util/summarizer");
 const convert_values_1 = require("../../r-bridge/lang-4.x/convert-values");
 const type_1 = require("../../r-bridge/lang-4.x/ast/model/type");
+/**
+ *
+ */
 function emptyCommonSyntaxTypeCounts(init = () => 0n) {
     return {
         total: init(),
@@ -115,6 +118,9 @@ function appendRecord(a, b) {
         get.push([(0, numbers_1.bigint2number)(val)]);
     }
 }
+/**
+ *
+ */
 function appendCommonSyntaxTypeCounter(a, b) {
     a.total.push([(0, numbers_1.bigint2number)(b.total)]);
     a.empty.push([(0, numbers_1.bigint2number)(b.empty)]);
@@ -136,6 +142,9 @@ function appendCommonSyntaxTypeCounter(a, b) {
 function summarizeRecord(a) {
     return Object.fromEntries(Object.entries(a).map(([key, val]) => [key, (0, summarizer_1.summarizeMeasurement)(val.flat(), val.length)]));
 }
+/**
+ *
+ */
 function summarizeCommonSyntaxTypeCounter(a) {
     return {
         total: (0, summarizer_1.summarizeMeasurement)(a.total.flat(), a.total.length),

package/statistics/features/feature.d.ts

@@ -2,7 +2,6 @@
  * This module holds the definition of what a {@link Feature} that can be extracted from an R AST is.
  *
  * Furthermore, it contains the definition of all features that are known in {@link ALL_FEATURES}.
- *
  * @module
  */
 import type { EvalOptions } from 'xpath-ts2/src/parse-api';
@@ -38,9 +37,7 @@ export interface FeatureProcessorInput extends MergeableRecord {
 export type FeatureProcessor<T extends FeatureInfo> = (existing: T, input: FeatureProcessorInput) => T;
 /**
  * A feature is something to be retrieved by the statistics.
- *
  * @typeParam T - The type of what should be collected for the feature
- *
  * @see ALL_FEATURES
  */
 export interface Feature<T extends FeatureInfo> {
@@ -54,7 +51,6 @@ export interface Feature<T extends FeatureInfo> {
      * If present, this feature allows to post-process the results of the feature extraction (for the summarizer).
      * <p>
      * The extraction can use the output path to write files to, and should return the final output.
-     *
      * @param featureRoot - The root path to the feature directory which should contain all the files the feature can write to (already merged for every file processed)
      * @param info        - The feature statistic maps each file name/context encountered to the feature information as well as the meta statistics for the file
      * @param outputPath  - The path to write the output to (besides what is collected in the output and meta information)

package/statistics/features/feature.js

@@ -3,7 +3,6 @@
  * This module holds the definition of what a {@link Feature} that can be extracted from an R AST is.
  *
  * Furthermore, it contains the definition of all features that are known in {@link ALL_FEATURES}.
- *
  * @module
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/statistics/features/post-processing.d.ts

@@ -5,8 +5,14 @@ export interface SummarizedWithProject<Uniques = Set<string>, Count = number[]>
     uniqueFiles: Uniques;
     count: Count;
 }
+/**
+ *
+ */
 export declare function emptySummarizedWithProject(): SummarizedWithProject;
 export type ReplaceKeysForSummary<Source, Target> = MergeableRecord & {
     [K in keyof Source]: Target;
 };
+/**
+ *
+ */
 export declare function recordFilePath(summarize: SummarizedWithProject, filepath: string, config: StatisticsSummarizerConfiguration): void;

package/statistics/features/post-processing.js

@@ -6,6 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.emptySummarizedWithProject = emptySummarizedWithProject;
 exports.recordFilePath = recordFilePath;
 const path_1 = __importDefault(require("path"));
+/**
+ *
+ */
 function emptySummarizedWithProject() {
     return {
         uniqueProjects: new Set(),
@@ -13,6 +16,9 @@ function emptySummarizedWithProject() {
         count: []
     };
 }
+/**
+ *
+ */
 function recordFilePath(summarize, filepath, config) {
     summarize.uniqueFiles.add(filepath);
     summarize.uniqueProjects.add(filepath.split(path_1.default.sep)[config.projectSkip] ?? '');

package/statistics/features/supported/assignments/post-process.d.ts

@@ -1,3 +1,6 @@
 import type { FeatureStatisticsWithMeta } from '../../feature';
 import type { StatisticsSummarizerConfiguration } from '../../../summarizer/summarizer';
+/**
+ *
+ */
 export declare function postProcess(featureRoot: string, info: Map<string, FeatureStatisticsWithMeta>, outputPath: string, config: StatisticsSummarizerConfiguration): void;

package/statistics/features/supported/assignments/post-process.js

@@ -101,6 +101,9 @@ function writeAssignmentOperatorsToCsv(outputPath, collected) {
     }
     fnOutStream.close();
 }
+/**
+ *
+ */
 function postProcess(featureRoot, info, outputPath, config) {
     const collected = {
         assignmentOperator: {},

package/statistics/features/supported/comments/post-process.d.ts

@@ -1,3 +1,6 @@
 import type { FeatureStatisticsWithMeta } from '../../feature';
 import type { StatisticsSummarizerConfiguration } from '../../../summarizer/summarizer';
+/**
+ *
+ */
 export declare function postProcess(featureRoot: string, info: Map<string, FeatureStatisticsWithMeta>, outputPath: string, config: StatisticsSummarizerConfiguration): void;

package/statistics/features/supported/comments/post-process.js

@@ -30,6 +30,9 @@ function mapComments(data, fn) {
     }
     return collected;
 }
+/**
+ *
+ */
 function postProcess(featureRoot, info, outputPath, config) {
     // for each we collect the count and the number of files that contain them
     const collected = mapComments(comments_1.initialCommentInfo, initialCommentsMeta);

package/statistics/features/supported/control-flow/post-process.d.ts

@@ -1,3 +1,6 @@
 import type { FeatureStatisticsWithMeta } from '../../feature';
 import type { StatisticsSummarizerConfiguration } from '../../../summarizer/summarizer';
+/**
+ *
+ */
 export declare function postProcess(featureRoot: string, info: Map<string, FeatureStatisticsWithMeta>, outputPath: string, config: StatisticsSummarizerConfiguration): void;

package/statistics/features/supported/control-flow/post-process.js

@@ -9,6 +9,9 @@ const post_processing_1 = require("../../post-processing");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const summarizer_1 = require("../../../../util/summarizer");
+/**
+ *
+ */
 function postProcess(featureRoot, info, outputPath, config) {
     const collected = {
         ifThen: (0, common_syntax_probability_1.emptyCommonSyntaxTypeCounts)(() => []),

package/statistics/features/supported/data-access/data-access.d.ts

@@ -1,6 +1,6 @@
 import type { Feature } from '../../feature';
 import type { Writable } from 'ts-essentials';
-import type { CommonSyntaxTypeCounts } from '../../common-syntax-probability';
+import { type CommonSyntaxTypeCounts } from '../../common-syntax-probability';
 declare const initialDataAccessInfo: {
     singleBracket: Record<number, bigint | CommonSyntaxTypeCounts>;
     doubleBracket: Record<number, bigint | CommonSyntaxTypeCounts>;

package/statistics/features/supported/data-access/post-process.d.ts

@@ -1,3 +1,6 @@
 import type { FeatureStatisticsWithMeta } from '../../feature';
 import type { StatisticsSummarizerConfiguration } from '../../../summarizer/summarizer';
+/**
+ *
+ */
 export declare function postProcess(featureRoot: string, info: Map<string, FeatureStatisticsWithMeta>, outputPath: string, config: StatisticsSummarizerConfiguration): void;

package/statistics/features/supported/data-access/post-process.js

@@ -67,6 +67,9 @@ function writeSingleOrDoubleBrackets(data, outputPath, key) {
         }
     }
 }
+/**
+ *
+ */
 function postProcess(featureRoot, info, outputPath, config) {
     const summarize = {
         singleBracket: new Map(),

package/statistics/features/supported/defined-functions/defined-functions.d.ts

@@ -1,7 +1,7 @@
 import type { Feature } from '../../feature';
 import type { Writable } from 'ts-essentials';
 import type { MergeableRecord } from '../../../../util/objects';
-import type { SourcePosition } from '../../../../util/range';
+import { type SourcePosition } from '../../../../util/range';
 declare const initialFunctionDefinitionInfo: {
     /** all, anonymous, assigned, non-assigned, ... */
     total: number;

package/statistics/features/supported/expression-list/post-process.d.ts

@@ -1,3 +1,6 @@
 import type { FeatureStatisticsWithMeta } from '../../feature';
 import type { StatisticsSummarizerConfiguration } from '../../../summarizer/summarizer';
+/**
+ *
+ */
 export declare function postProcess(featureRoot: string, info: Map<string, FeatureStatisticsWithMeta>, outputPath: string, config: StatisticsSummarizerConfiguration): void;

package/statistics/features/supported/expression-list/post-process.js

@@ -8,6 +8,9 @@ const post_processing_1 = require("../../post-processing");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const summarizer_1 = require("../../../../util/summarizer");
+/**
+ *
+ */
 function postProcess(featureRoot, info, outputPath, config) {
     const collected = {};
     const deepestNestingOut = fs_1.default.createWriteStream(path_1.default.join(outputPath, 'deepest-nesting-per-file.csv'));

package/statistics/features/supported/loops/post-process.d.ts

@@ -1,3 +1,6 @@
 import type { FeatureStatisticsWithMeta } from '../../feature';
 import type { StatisticsSummarizerConfiguration } from '../../../summarizer/summarizer';
+/**
+ *
+ */
 export declare function postProcess(featureRoot: string, info: Map<string, FeatureStatisticsWithMeta>, outputPath: string, config: StatisticsSummarizerConfiguration): void;

package/statistics/features/supported/loops/post-process.js

@@ -10,6 +10,9 @@ const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const numbers_1 = require("../../../../util/numbers");
 const summarizer_1 = require("../../../../util/summarizer");
+/**
+ *
+ */
 function postProcess(featureRoot, info, outputPath, config) {
     const collected = {
         forLoops: (0, common_syntax_probability_1.emptyCommonSyntaxTypeCounts)(() => []),

package/statistics/features/supported/used-functions/used-functions.d.ts

@@ -1,6 +1,6 @@
 import type { Feature } from '../../feature';
 import type { Writable } from 'ts-essentials';
-import type { CommonSyntaxTypeCounts } from '../../common-syntax-probability';
+import { type CommonSyntaxTypeCounts } from '../../common-syntax-probability';
 declare const initialFunctionUsageInfo: {
     allFunctionCalls: number;
     args: Record<number, bigint | CommonSyntaxTypeCounts>;

package/statistics/features/supported/used-packages/post-process.d.ts

@@ -1,3 +1,6 @@
 import type { FeatureStatisticsWithMeta } from '../../feature';
 import type { StatisticsSummarizerConfiguration } from '../../../summarizer/summarizer';
+/**
+ *
+ */
 export declare function postProcess(featureRoot: string, info: Map<string, FeatureStatisticsWithMeta>, outputPath: string, config: StatisticsSummarizerConfiguration): void;

package/statistics/features/supported/used-packages/post-process.js

@@ -12,6 +12,9 @@ const summarizer_1 = require("../../../../util/summarizer");
 const files_1 = require("../../../../util/files");
 const strings_1 = require("../../../../util/text/strings");
 const arrays_1 = require("../../../../util/collections/arrays");
+/**
+ *
+ */
 function postProcess(featureRoot, info, outputPath, config) {
     const collected = {};
     for (const [filepath, data] of info.entries()) {

package/statistics/features/supported/values/post-process.d.ts

@@ -1,3 +1,6 @@
 import type { FeatureStatisticsWithMeta } from '../../feature';
 import type { StatisticsSummarizerConfiguration } from '../../../summarizer/summarizer';
+/**
+ *
+ */
 export declare function postProcess(featureRoot: string, info: Map<string, FeatureStatisticsWithMeta>, outputPath: string, config: StatisticsSummarizerConfiguration): void;

package/statistics/features/supported/values/post-process.js

@@ -11,6 +11,9 @@ const summarizer_1 = require("../../../../util/summarizer");
 const time_1 = require("../../../../util/text/time");
 const files_1 = require("../../../../util/files");
 const arrays_1 = require("../../../../util/collections/arrays");
+/**
+ *
+ */
 function postProcess(featureRoot, info, outputPath, config) {
     const collected = {};
     for (const [filepath, data] of info.entries()) {

package/statistics/features/supported/variables/post-process.d.ts

@@ -1,9 +1,15 @@
 import type { FeatureStatisticsWithMeta } from '../../feature';
-import type { SummarizedWithProject } from '../../post-processing';
+import { type SummarizedWithProject } from '../../post-processing';
 import type { StatisticsSummarizerConfiguration } from '../../../summarizer/summarizer';
+/**
+ *
+ */
 export declare function postProcess(featureRoot: string, info: Map<string, FeatureStatisticsWithMeta>, outputPath: string, config: StatisticsSummarizerConfiguration): void;
 type VariableInfoMap = Map<string, SummarizedWithProject & {
     linePercentageInFile: number[][];
 }>;
+/**
+ *
+ */
 export declare function writeVariableInfoToCsv(outputPath: string, filename: `${string}.csv`, data: VariableInfoMap): void;
 export {};

package/statistics/features/supported/variables/post-process.js

@@ -58,6 +58,9 @@ function collectInformation(info, config) {
     }
     return collected;
 }
+/**
+ *
+ */
 function postProcess(featureRoot, info, outputPath, config) {
     const collected = collectInformation(info, config);
     writeVariableCountsToCsv(outputPath, collected);
@@ -65,6 +68,9 @@ function postProcess(featureRoot, info, outputPath, config) {
     collectDefinedVariables(featureRoot, info, config, outputPath);
     collectRedefinedVariables(featureRoot, info, config, outputPath);
 }
+/**
+ *
+ */
 function writeVariableInfoToCsv(outputPath, filename, data) {
     const out = fs_1.default.createWriteStream(path_1.default.join(outputPath, filename));
     out.write(`variable,unique-projects,unique-files,${(0, summarizer_1.summarizedMeasurement2CsvHeader)('count')},${(0, summarizer_1.summarizedMeasurement2CsvHeader)('line-frac')}\n`);

package/statistics/meta-statistics.d.ts

@@ -1,26 +1,25 @@
 import type { RParseRequestFromFile, RParseRequestFromText } from '../r-bridge/retriever';
 /**
  * Statistics on skipped files, the time required, and more.
- *
  * @see extractUsageStatistics
  * @see initialMetaStatistics
  */
 export interface MetaStatistics {
     /**
-   * The number of requests that were parsed successfully
-   */
+     * The number of requests that were parsed successfully
+     */
     successfulParsed: number;
     /**
-   * The processing time for each request
-   */
+     * The processing time for each request
+     */
     processingTimeMs: number[];
     /**
-   * All failed requests (e.g., if they can not be converted to XML)
-   */
+     * All failed requests (e.g., if they can not be converted to XML)
+     */
     failedRequests: (RParseRequestFromText | RParseRequestFromFile)[];
     /**
-   * Number of lines with each individual line length consumed for each request
-   */
+     * Number of lines with each individual line length consumed for each request
+     */
     lines: number[][];
     /**
      * The number of nodes in the normalized AST

package/statistics/output/file-provider.d.ts

@@ -7,7 +7,6 @@ export declare class DummyAppendProvider implements StatisticAppendProvider {
     private readonly map;
     /**
      * If you pass a map the dummy will log all append calls to the map, using the feature name and the appendage type as keys
-     *
      * @param map - The map to log to
      */
     constructor(map?: DummyAppendMemoryMap | undefined);
@@ -25,13 +24,13 @@ export declare class StatisticFileProvider implements StatisticAppendProvider {
     private readonly connections;
     constructor(statisticsDirectory: string | undefined);
     /**
-   * @param name - the name of the feature {@link Feature#name}
-   * @param fn - the name of the feature-aspect to record
-   */
+     * @param name - the name of the feature {@link Feature#name}
+     * @param fn - the name of the feature-aspect to record
+     */
     private statisticsFile;
     /**
-   * Append the given content to the information for a feature of the given name and function.
-   */
+     * Append the given content to the information for a feature of the given name and function.
+     */
     append(name: string, fn: AppendFnType, content: string): void;
     private getHandle;
 }

package/statistics/output/file-provider.js

@@ -12,7 +12,6 @@ class DummyAppendProvider {
     map;
     /**
      * If you pass a map the dummy will log all append calls to the map, using the feature name and the appendage type as keys
-     *
      * @param map - The map to log to
      */
     constructor(map = undefined) {
@@ -63,15 +62,15 @@ class StatisticFileProvider {
         });
     }
     /**
-   * @param name - the name of the feature {@link Feature#name}
-   * @param fn - the name of the feature-aspect to record
-   */
+     * @param name - the name of the feature {@link Feature#name}
+     * @param fn - the name of the feature-aspect to record
+     */
     statisticsFile(name, fn) {
         return path_1.default.join(this.statisticsDirectory, name, `${fn}${exports.defaultStatisticsFileSuffix}`);
     }
     /**
-   * Append the given content to the information for a feature of the given name and function.
-   */
+     * Append the given content to the information for a feature of the given name and function.
+     */
     append(name, fn, content) {
         const descriptor = this.getHandle(name, String(fn));
         fs_1.default.appendFileSync(descriptor, content + '\n', 'utf8');

package/statistics/output/print-stats.d.ts

@@ -1,5 +1,5 @@
 import type { MetaStatistics } from '../meta-statistics';
-import type { FeatureKey, FeatureStatistics } from '../features/feature';
+import { type FeatureKey, type FeatureStatistics } from '../features/feature';
 interface MinMaxAvgMedian {
     sum: number;
     min: number;
@@ -7,11 +7,23 @@ interface MinMaxAvgMedian {
     avg: number;
     median: number;
 }
+/**
+ * Calculates the min, max, average and median of the given data set.
+ */
 export declare function minMaxAvgAndMedian(data: number[]): MinMaxAvgMedian;
+/**
+ * Formats the given statistics as a string.
+ */
 export declare function statsString(data: MinMaxAvgMedian, suffix?: string): string;
+/**
+ * Prints the given feature statistics to the console.
+ */
 export declare function printFeatureStatistics(statistics: {
     features: FeatureStatistics;
     meta: MetaStatistics;
 }, features?: 'all' | Set<FeatureKey>): void;
+/**
+ * Prints a single feature statistics entry to the console.
+ */
 export declare function printFeatureStatisticsEntry(info: Record<string, unknown>): void;
 export {};

package/statistics/output/print-stats.js

@@ -8,6 +8,9 @@ const ansi_1 = require("../../util/text/ansi");
 const json_1 = require("../../util/json");
 const feature_1 = require("../features/feature");
 const arrays_1 = require("../../util/collections/arrays");
+/**
+ * Calculates the min, max, average and median of the given data set.
+ */
 function minMaxAvgAndMedian(data) {
     data = data.sort((a, b) => a - b);
     const sum = (0, arrays_1.arraySum)(data);
@@ -22,9 +25,15 @@ function minMaxAvgAndMedian(data) {
 function formatStatNumber(num) {
     return num === undefined ? '<?>' : Number(num.toFixed(3)).toLocaleString();
 }
+/**
+ * Formats the given statistics as a string.
+ */
 function statsString(data, suffix = '') {
     return `[${formatStatNumber(data.min)}${suffix} .. ${formatStatNumber(data.max)}${suffix}] (avg: ${formatStatNumber(data.avg)}${suffix}, median: ${formatStatNumber(data.median)}${suffix})`;
 }
+/**
+ * Prints the given feature statistics to the console.
+ */
 function printFeatureStatistics(statistics, features = 'all') {
     for (const feature of Object.keys(statistics.features)) {
         if (features !== 'all' && !features.has(feature)) {
@@ -48,6 +57,9 @@ function printFeatureStatistics(statistics, features = 'all') {
   `);
 }
 const pad = 3;
+/**
+ * Prints a single feature statistics entry to the console.
+ */
 function printFeatureStatisticsEntry(info) {
     let longestKey = 0;
     let longestValue = 0;

package/statistics/output/statistics-file.d.ts

@@ -1,4 +1,4 @@
-import type { DummyAppendMemoryMap, StatisticAppendProvider } from './file-provider';
+import { type DummyAppendMemoryMap, type StatisticAppendProvider } from './file-provider';
 /**
  * Requires source information to be attached on parsing!
  * <p>
@@ -13,7 +13,6 @@ export declare let statisticsFileProvider: StatisticAppendProvider;
 export declare function initFileProvider(outputDirectory: string): void;
 /**
  * Either ignore the statistics or write them to a given map (e.g., for testing).
- *
  * @param map - The map to write to, will not persist calls if no map is given
  */
 export declare function initDummyFileProvider(map?: DummyAppendMemoryMap): void;

package/statistics/output/statistics-file.js

@@ -32,7 +32,6 @@ function initFileProvider(outputDirectory) {
 }
 /**
  * Either ignore the statistics or write them to a given map (e.g., for testing).
- *
  * @param map - The map to write to, will not persist calls if no map is given
  */
 function initDummyFileProvider(map) {

package/statistics/statistics.d.ts

@@ -1,9 +1,9 @@
-import type { MetaStatistics } from './meta-statistics';
+import { type MetaStatistics } from './meta-statistics';
 import type { RParseRequestFromFile, RParseRequestFromText } from '../r-bridge/retriever';
 import type { PipelineOutput } from '../core/steps/pipeline/pipeline';
 import { DEFAULT_DATAFLOW_PIPELINE } from '../core/steps/pipeline/default-pipelines';
 import type { RShell } from '../r-bridge/shell';
-import type { FeatureSelection, FeatureStatistics } from './features/feature';
+import { type FeatureSelection, type FeatureStatistics } from './features/feature';
 import type { FlowrConfigOptions } from '../config';
 /**
  * By default, {@link extractUsageStatistics} requires a generator, but sometimes you already know all the files
@@ -13,13 +13,12 @@ export declare function staticRequests(...requests: (RParseRequestFromText | RPa
 type DataflowResult = PipelineOutput<typeof DEFAULT_DATAFLOW_PIPELINE>;
 /**
  * Extract all wanted statistic information from a set of requests using the presented R session.
- *
  * @param shell     - The R session to use
  * @param config    - The flowr config
  * @param onRequest - A callback that is called at the beginning of each request, this may be used to debug the requests.
  * @param features  - The features to extract (see {@link allFeatureNames}).
  * @param requests  - The requests to extract the features from. May generate them on demand (e.g., by traversing a folder).
- * 										If your request is statically known, you can use {@link staticRequests} to create this generator.
+ *                    If your request is statically known, you can use {@link staticRequests} to create this generator.
  * @param rootPath  - The root path to the project, this is used to relativize the file paths in the statistics.
  */
 export declare function extractUsageStatistics<T extends RParseRequestFromText | RParseRequestFromFile>(shell: RShell, config: FlowrConfigOptions, onRequest: (request: T) => void, features: FeatureSelection, requests: AsyncGenerator<T>, rootPath?: string): Promise<{

package/statistics/statistics.js

@@ -28,13 +28,12 @@ function staticRequests(...requests) {
 }
 /**
  * Extract all wanted statistic information from a set of requests using the presented R session.
- *
  * @param shell     - The R session to use
  * @param config    - The flowr config
  * @param onRequest - A callback that is called at the beginning of each request, this may be used to debug the requests.
  * @param features  - The features to extract (see {@link allFeatureNames}).
  * @param requests  - The requests to extract the features from. May generate them on demand (e.g., by traversing a folder).
- * 										If your request is statically known, you can use {@link staticRequests} to create this generator.
+ *                    If your request is statically known, you can use {@link staticRequests} to create this generator.
  * @param rootPath  - The root path to the project, this is used to relativize the file paths in the statistics.
  */
 async function extractUsageStatistics(shell, config, onRequest, features, requests, rootPath) {

package/statistics/summarizer/auto-detect.d.ts

@@ -1,2 +1,5 @@
 import { SummarizerType } from '../../util/summarizer';
+/**
+ * Auto-detects the summarization type based on the input path.
+ */
 export declare function detectSummarizationType(inputPath: string): Promise<SummarizerType>;

package/statistics/summarizer/auto-detect.js

@@ -7,6 +7,9 @@ exports.detectSummarizationType = detectSummarizationType;
 const fs_1 = __importDefault(require("fs"));
 const summarizer_1 = require("./summarizer");
 const log_1 = require("../../util/log");
+/**
+ * Auto-detects the summarization type based on the input path.
+ */
 async function detectSummarizationType(inputPath) {
     if (fs_1.default.statSync(inputPath).isFile()) {
         log_1.log.info(`Detected benchmark summarization with single file ${inputPath}`);

package/statistics/summarizer/post-process/clusterer.d.ts

@@ -11,14 +11,13 @@ export interface ClusterReport extends MergeableRecord {
     /** Maps each context encountered (i.e., every file that contains something associated with the feature) to a unique id, used in the {@link ClusterReport#valueInfoMap|valueInfoMap}. */
     contextIdMap: ClusterContextIdMap;
     /**
-   * Counts which contexts contained which values of a feature.
-   * For example, that `<-` occurred in files with ids `[12, 42, 19, 19]` (i.e., the context with the id 19 contained it twice).
-   */
+     * Counts which contexts contained which values of a feature.
+     * For example, that `<-` occurred in files with ids `[12, 42, 19, 19]` (i.e., the context with the id 19 contained it twice).
+     */
     valueInfoMap: ClusterValueInfoMap;
 }
 /**
  * Takes a statistics file like `statistics-out/top-2023-01-01-00-00-00/Assignments/assignmentOperator.txt` and clusters the values by context
- *
  * @param filepath     - Filepath of the statistics file
  * @param contextIdMap - The id map to use, can use an existing one to reuse ids for same contexts spreading over multiple input files.
  *  `undefined` is used for unknown contexts. This map allows us to reference contexts with a way shorter identifier (vs. the full file path).

package/statistics/summarizer/post-process/clusterer.js

@@ -7,7 +7,6 @@ exports.clusterStatisticsOutput = clusterStatisticsOutput;
 /**
  * Reading the given file line by line and expecting constructs of {@link StatisticsOutputFormat},
  * this module is responsible for identifying interesting groups of same data.
- *
  * @module
  */
 const n_readlines_1 = __importDefault(require("n-readlines"));
@@ -15,7 +14,6 @@ const defaultmap_1 = require("../../../util/collections/defaultmap");
 const decorate_1 = require("../../../r-bridge/lang-4.x/ast/model/processing/decorate");
 /**
  * Takes a statistics file like `statistics-out/top-2023-01-01-00-00-00/Assignments/assignmentOperator.txt` and clusters the values by context
- *
  * @param filepath     - Filepath of the statistics file
  * @param contextIdMap - The id map to use, can use an existing one to reuse ids for same contexts spreading over multiple input files.
  *  `undefined` is used for unknown contexts. This map allows us to reference contexts with a way shorter identifier (vs. the full file path).