clean_date_filter_arg: Transform a year range into the format required by a specific...

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

Transform a year range into the format required by a specific search engine

Description

Take a period definition and transform it into a specific format passed through the cases argument.

Usage

clean_date_filter_arg(
  year_query,
  cases,
  arg_in_query_test = NULL,
  query = NULL
)

Arguments

year_query	A string identifying a search period (see Details).
cases	The search engine syntax specification into which convert the year query It needs to be a list with the following items: gt (greater than), ge (greater than or equal to), lt (lower than), le (lower than or equal to), eq (equal to), range (range of years). Inside the specification, the year in the query can be retrieved with the year_piece placeholder, which in the case of a closed range is a vector of two elements (see examples).
arg_in_query_test	A search engine syntax tag that identifies a year filter. Useful to define an already existing year filter in the query. If arg_in_query_test is set, also the query argument must be set.
query	The search query. Needed to test if a year filter is already present. If query is set, also the arg_in_query_test argument must be set.

Details

The input period specified in year_query must follow this format:

• > Year: greater than Year.

• >= Year: greater then or equal to Year.

• < Year: lower than Year.

• <= Year: lower then or equal to Year.

• Year: equal to Year.

• Year1-Year2: range from Year1 to Year2.

The input is checked to evaluate if year_query the format is clearly invalid.

Value

The formatted, search engine specific, period filter.

Examples

query <- "Test query"
year_query <- "2010-2020"


## Example for Web Of Science
year_query <- clean_date_filter_arg(year_query,
  cases = list(
    gt = "{year_piece + 1}-{year(today())}", ge = "{year_piece}-{year(today())}",
    eq = "{year_piece}-{year_piece}", le = "1985-{year_piece}",
    range = "{year_piece[1]}-{year_piece[2]}", lt = "1985-{year_piece - 1}"
  ),
  arg_in_query_test = "PY ?=", query = query
)

## Example for Pubmed
year_query <- "2010-2020"

year_query <- clean_date_filter_arg(year_query,
  cases = list(
    gt = "{year_piece + 1}[PDAT]:{year(today())}[PDAT]",
    ge = "{year_piece}[PDAT]:{year(today())}[PDAT]",
    eq = "{year_piece}[PDAT]:{year_piece}[PDAT]",
    le = "1000[PDAT]:{year_piece}[PDAT]",
    lt = "1000[PDAT]:{year_piece - 1}[PDAT]",
    range = "{year_piece[1]}[PDAT]:{year_piece[2]}[PDAT]"
  ),
  arg_in_query_test = "[PDAT]", query = query
)

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