extract_source_file_paths: Extract the path to citation records files

In bakaburg1/BaySREn: BaySREn. An R package to automatise citation collection and screening in Systematic Reviews. Based on Bayesian active machine learning

Extract the path to citation records files

Description

The information on the records' location is stored in the session journal created by perform_search_session(). It is possible to select records from specific session, query, or source combinations. Only parsed or API downloaded record paths will be returned, not the raw data source files.

Usage

extract_source_file_paths(
  journal,
  sessions = journal$Session_ID,
  queries = journal$Query_ID,
  sources = journal$Source,
  records_folder = "Records"
)

Arguments

journal	A data frame produced by perform_search_session() or a file path to it.
sessions, queries, sources	Sessions, queries and sources for the which one wants to get the record data. By default, all record file paths are retrieved.
records_folder	The path to the folder where the records are stored. By default is named Records.

Value

A vector of file paths.

Examples

## Not run: 
journal <- perform_search_session(
  query = query, year_query = year_filter,
  session_name = "Session1", query_name = "Query1",
  records_folder = "Records",
  journal = "Session_journal.csv"
)

# using the journal as data frame
paths <- extract_source_file_paths(journal)

# using the journal path
paths <- extract_source_file_paths("Session_journal.csv")

## End(Not run)

bakaburg1/BaySREn documentation built on March 30, 2022, 12:16 a.m.