metagear (version 0.1)

effort_summary: Provides a text summary of screening efforts among the reviewing team.

Description

Summarizes the number of studies screened, which were identified to be included/excluded from the project, as well as those with conflicting agreement on their inclusion/exclusion. If a dual (paired) design was implemented to screen references, then it also provides inter-reviewer agreement estimate following Cohen (1960) that describes the aggreement (or repeatability) of screening/coding decisions.

Usage

effort_summary(aDataFrame, column_reviewers = "REVIEWERS",
  column_effort = "INCLUDE", dual = FALSE, quiet = FALSE)

Arguments

aDataFrame

A data.frame containing the titles and abstracts that were screened by a team. The default assumes that the data.frame is the merged effort across the team using effort_merge.

column_reviewers

Changes the default label of the "REVIEWERS" column that contains the screening efforts of each team member.

column_effort

Changes the default label of the "INCLUDE" column that contains the screening decisions (coded references) of each team member.

dual

When TRUE, provides a summary of the dual screening effort as well as estimation of inter-reviewer agreements following Cohen's (1960) kappa (K) and Landis and Koch's (1977) interpretation benchmarks.

quiet

When TRUE, does not print to console the summary table.

Value

• A data frame with summary information on the screening tasks of a reviewing team.

References

Cohen, J. 1960. A coefficient of agreement for nominal scales. Educational and Psychological Measurement 20: 37-46. Landis, J.R., and Koch, G.G. 1977. The measurement of observer agreement for categorical data. Biometrics 33: 159-174.

See Also

effort_initialize, effort_distribute, effort_merge