Skip to contents

The app

Run the whole review without writing R.

launch() launch_app()
Open the metawoRld app

Create a project

new_review()
Start a new review with sensible defaults
create_metawoRld()
Create a new metawoRld project
use_templates()
Add or update the forms, prompts and rules templates in a project
read_config()
Read the project configuration
read_people() add_person()
People and tools of a project
example_project()
Build the worked example project

Forms

What is extracted, defined in forms/*.yml.

get_schema() read_form()
Read a form from a metawoRld project
list_forms()
List the forms of a project
export_schemas()
Write JSON Schemas and Table Schemas for the project's forms
table_schema()
Frictionless Table Schema for the data points of a form
validate_against_schema()
Validate data against a metawoRld schema
validate_links()
Validate links between data points and metadata
schema_refs()
List the cross-references defined in a schema
schema_col_types()
Column types for a study's data.csv derived from the schema

Search and screening log

Searches, records and screening decisions; PRISMA counts are computed from these files.

add_search()
Record a literature search
read_records() add_records() link_record()
The record registry
record_id()
Record ids
add_screening() screening_status()
Screening decisions
prisma_counts()
Counts for a PRISMA 2020 flow diagram

Submit (the one door)

Every input channel submits through the same validated intake.

submit_study()
Submit an extraction of a study
submission_template()
Write blank files for a submission
check_submission()
Check a submission
list_submissions()
List submissions
read_submission()
Read a submission

Accept and reconcile

accept_submission()
Accept a submission
reject_submission()
Reject a submission
compare_with_accepted()
What a submission would change in an accepted study
compare_extractions()
Compare extractions of the same study
reconcile()
Reconcile two or more extractions
add_study_data()
Write accepted study data (low level)

Study ids and identifiers

is_study_id() check_study_id() suggest_study_id()
Check or suggest study ids
normalize_identifier()
Normalize study identifiers
identifier_type()
Detect the type of a study identifier
sanitize_id() desanitize_id()
Encode an identifier so it can be used as a file or folder name

Load data

load_metawoRld()
Load all studies of a metawoRld project
read_study()
Read one study from a metawoRld project
list_studies()
List the studies in a project

Verify values against the papers

review_values() review_values_app()
Review extracted values against the papers
check_values()
Check extracted values for plausibility and consistency
verification_status()
Verification status of data points
set_verification()
Record the verification of data points
update_data_point()
Correct a data point

Integrity

check_project()
Check a whole metawoRld project
use_github_action_check()
Add a GitHub Actions workflow that runs check_project()
hash_file()
SHA-256 hash of a file
validate_study()
Validate one study
validate_world()
Validate all studies in a project

Groups, subgroups and categories

Groups as reported, facts inherited by subgroups, categories as rules, and refinement during the review.

group_memberships()
Which categories each study group belongs to
group_category()
Assign study groups to group categories
add_group_fact()
Add a fact to the groups of the extraction form
refinement_queue()
Groups waiting for a fact
amend_study()
Amend an accepted study

Vocabulary and value rules

read_rules()
Read the project's value rules
add_variable_synonym()
Add a variable or synonym to the project's rules
canonical_variable()
Map variable names to their canonical names
rules_for_prompt()
The project vocabulary formatted for an LLM prompt

Working as a team (Git)

sync_project()
Share and fetch work with the rest of the team
sync_status()
Sharing status of a project
commit_project()
Save (commit) the project's changes

Living meta-analysis

read_analyses()
Read the project's meta-analysis definitions
write_analyses()
Write the project's meta-analysis definitions
run_meta_analysis()
Run a meta-analysis
run_all_meta_analyses()
Run all meta-analyses of a project
summary_of_findings()
Summary of findings table
analysis_data()
Data used in a meta-analysis
to_mean_sd()
Convert summary statistics to mean and SD
plot_forest()
Forest plot of a meta-analysis
plot_cumulative()
Cumulative meta-analysis plot
plot_variable()
Plot all reported values of a variable

Website dashboard

generate_website()
Generate (and render) the project website
generate_dashboard()
Generate the dashboard pages of the website
generate_study_webpage()
Generate one web page per study
use_github_action_quarto()
Add a GitHub Actions workflow that publishes the website