CoLRev

Manual

  • Steps and operations
  • Workflow
  • Step 1: Problem formulation
  • Step 2: Metadata retrieval
  • Step 3: Metadata prescreen
  • Step 4: PDF retrieval
  • Step 5: PDF screen
  • Step 6: Data extraction and synthesis
  • Command-line Interface
  • Collaboration
  • Packages
  • Appendix

Developer documentation

  • Setup
  • Package development
  • Development status
  • API reference
  • Github repository
  • PyPI

Governance

  • CoLRev enhancement proposals (CEPs)
  • About
CoLRev
  • colrev.ops.search_db.run_db_search
  • Edit on GitHub

colrev.ops.search_db.run_db_search

colrev.ops.search_db.run_db_search(*, db_url, source, add_to_git=False, project_root=None, **kwargs)[source]

Run the database search.

add_to_git: when True, stage changes via a locally instantiated GitRepo. project_root: optional explicit root path; if not provided, derive from the source.

Return type:

None


© Copyright 2025, Gerit Wagner and Julian Prester.

Built with Sphinx using a theme provided by Read the Docs.