Shortcut: WD:ORWikidata:Tools/OpenRefine
OpenRefine is a free data wrangling tool that can be used to clean tabular data and connect it with knowledge bases, including Wikidata. It was previously developed by Google (under the name Google Refine) and has now transitioned to a community-supported project.
This page gathers OpenRefine recipes that can be useful to import datasets into Wikidata, or augment datasets with additional data extracted from Wikidata. Feel free to use the talk page to ask for help with the software. If you enjoy using this tool, you can spread the word with the {{User loves OpenRefine}} userbox.
OpenRefine currently only supports reconciling items. Lexemes are not supported as of September 2022.
Install and run OpenRefine
[edit]OpenRefine can be downloaded as an application. It works on desktop and laptop computers with Windows, Mac and Linux operating systems. It runs a small server on your computer and you then use a web browser to interact with it. It works best with browsers based on Webkit, such as Google Chrome, Chromium, Opera and Microsoft Edge, and is also supported on Firefox.
OpenRefine has a graphical user interface which is available in more than 15 languages.
Install OpenRefine on your own desktop or laptop computer
[edit]You can find and download the latest stable release of OpenRefine here.
Run OpenRefine on PAWS
[edit]Since May 2021, everyone with a registered Wikimedia account can run OpenRefine in PAWS on Wikimedia's Cloud Services. Please note that this is an experimental feature which is not supported by the OpenRefine team itself, and which may break or malfunction. It is however an interesting option for people who can't install software on their local computer.
PAWS is a Wikimedia Cloud tool that provides hosted access to Jupyter notebooks and other tools without needing any local installation.
You can access your own installation of OpenRefine with this link: https://hub-paws.wmcloud.org/hub/user-redirect/openrefine. You'll have to login with your wiki credentials, but don't tick Remember me box: as all files written on PAWS are publicly available, you don't want to let your credentials accessible. It is also possible that you will get an error message; if that is the case, then refresh the page and it should work.
Please contact YuviPanda with questions about OpenRefine via PAWS.
Main features
[edit]Wikidata reconciliation
[edit]In OpenRefine terminology, reconciliation is the process of linking free-text tabular cells to identifiers in knowledge bases. OpenRefine's built-in reconciliation capabilities make it a versatile tool to reconcile tabular data to a wide range of databases, including Wikidata.
OpenRefine's wiki contains a detailed guide to the reconciliation process. Here are the main features:
- Restrict the reconciliation to a Wikidata class. Only items from subclasses of this Wikidata class will be considered;
- Alternatively, select "Reconcile against no particular type" where the item can be of any class (e.g. when reconciling against the item labels or titles of Wikipedia articles);
- Use multiple columns in your dataset and match them against values of properties in Wikidata, which refines the reconciliation score and acts as a tiebreaker between namesakes;
- Use the external identifiers shared by your dataset and Wikidata to reconcile your items;
- Use the sitelinks provided in your dataset as external identifiers - if these Wikimedia pages are linked to a Wikidata item, they will automatically be reconciled to that;
- If the tool found multiple candidates you can go through the table to match or the correct Wikidata item.
If you want to use the reconciliation features, consider engaging with the following instruction materials:
- These features are explained in great detail by Owen Stephens in his series of screencasts on the topic.
- ArthurPSmith demonstrated its use with Wikidata at WikidataCon 2017.
APIs can be, for instance a search on frlabels with wikidata thanks to this link https://wikidata.reconci.link/fr/api.
Data augmentation
[edit]
This feature is available from OpenRefine 2.8 onwards.
Once a column of your table is reconciled to Wikidata, you can pull data from Wikidata, creating other columns in your dataset. If there are multiple claims for a given property, the values will be grouped as records in OpenRefine: they are stored in additional rows where the original reconciled column is blank. OpenRefine's record mode might therefore be more suitable for the later transformations you want to carry out on your table. Access to item labels, item descriptions and item sitelinks is provided by properties Lxx, Dxx and Syyyy, where xx is a language code (en, fr, yue, etc.) and yyyy is a site ID (enwiki, ptwikisource, etc.).
You can use this function recursively on the newly-created columns if they correspond to Wikidata items. This lets you explore the Wikidata graph along selected properties. It is also possible to configure the way you retrieve the properties in various ways (for instance, filtering by rank or references).
Wikidata editing
[edit]This feature is available from OpenRefine 3.0 onwards.
OpenRefine can help you transform tabular data into Wikidata statements. This works by creating a schema - a template of Wikidata edit that is applied to each row of your table. Once you have created a schema, you can:
- preview the Wikidata edits and inspect them manually;
- analyze and fix any issues raised automatically by the tool;
- upload your changes to Wikidata by logging in with your own account;
- export the changes to the QuickStatements v1 format.
See the editing subpage for more details. Many tutorials are available to get you started.
Recipes
[edit]OpenRefine workflows can be shared by copying the JSON representation of the edit history. This represents the operations you have made in OpenRefine, and can be reused by others on similar datasets. This section lists some recipes that can be useful when working with Wikidata. See also OpenRefine Recipes.
- Obtaining Wikidata Q numbers. Once you have reconciled a column to Wikidata, you can obtain the Qids in a new column, by using the Add column based on this column operation with the following GREL expression:
cell.recon.match.id
- More variables. You can access many different variables for the reconciled cell. See the reference page for variables.
- Share your recipe here!
Help OpenRefine
[edit]OpenRefine needs your help! There are many things you can do:
- improve this documentation or OpenRefine's own documentation
- help translate OpenRefine in your language with Weblate
- contribute to OpenRefine's development or more specifically on Wikidata-related features
- get involved in user support, for instance on the forum
We have a Phabricator project to track activity around OpenRefine within Wikimedia; feel free to tag any related task with it.
Over 2021-22, OpenRefine is being extended with Structured Data on Wikimedia Commons (SDC) support. This project is funded by a Wikimedia Foundation Project Grant.