Learn R Programming

searchAnalyzeR (version 0.1.0)

SearchAnalyzer: Search Strategy Analytics Engine

Description

The SearchAnalyzer class provides a comprehensive framework for analyzing the performance of systematic review search strategies. It calculates precision, recall, and other performance metrics, generates visualizations, and supports validation against gold standard datasets.

Arguments

Methods

new(search_results, gold_standard, search_strategy)

Initialize analyzer

calculate_metrics()

Calculate comprehensive performance metrics

visualize_performance(type)

Generate performance visualizations

Public fields

search_results

Data frame containing search results

gold_standard

Reference set of relevant articles

metadata

Search strategy metadata

Methods


Method new()

Initialize the analyzer with search results and optional gold standard.

Usage

SearchAnalyzer$new(
  search_results,
  gold_standard = NULL,
  search_strategy = NULL
)

Arguments

search_results

Data frame with search results

gold_standard

Vector of known relevant article IDs

search_strategy

List containing search parameters

Returns

No return value, called for side effects Calculate comprehensive performance metrics


Method calculate_metrics()

Usage

SearchAnalyzer$calculate_metrics()

Returns

List of performance metrics Generate performance visualization


Method visualize_performance()

Usage

SearchAnalyzer$visualize_performance(type = "overview")

Arguments

type

Type of visualization

Returns

ggplot object


Method clone()

The objects of this class are cloneable with this method.

Usage

SearchAnalyzer$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Details

Core class for analyzing systematic review search strategies

This R6 class encapsulates all functionality needed for search strategy analysis. Key capabilities include:

  • Performance metric calculation (precision, recall, F1, efficiency)

  • Temporal and database coverage analysis

  • Visualization generation for reports

  • Gold standard validation