API Reference

Modules, classes, and functions for building on ResearchArcade.

Clear

Updated:

Overview

This section lists public modules in the research_arcade package. Click a module to view detailed classes, methods, and examples. We recommend one HTML page per module (or submodule), e.g.:

  • api/research_arcade.html — top-level interfaces
  • api/research_arcade.csv_backend.html — CSV data management
  • api/research_arcade.sql_backend.html — PostgreSQL data management
  • api/research_arcade.utils.html — shared utilities
  • api/research_arcade.openreview.html — OpenReview tables & ops
  • api/research_arcade.arxiv.html — ArXiv tables & ops

Writing module pages

Each module page can reuse your article template (see pages/template.html). Suggested structure:

  1. Header & breadcrumbs (back to API index)
  2. Module description (what it provides; key concepts)
  3. Public classes with constructor args and short examples
  4. Key functions/methods with parameters & return types
  5. Short code snippets for common workflows
from research_arcade import ResearchArcade

ra = ResearchArcade(db_type="csv", config={"csv_dir": "/path/to/csv"})
papers = ra.get_all_node_features("openreview_papers")
print(len(papers))