4. Token history of specific revision.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Tutorial 4: Token history of specific revision\n",
    "\n",
    "The previous tutorial explain how to analyze the history of all tokens. In this case we will limit the history to one revision.\n",
    "\n",
    "In order to do this, two functions `all_content()` and `specific_rev_content_by_article_title()` are required."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 1. Set Up the dataframes\n",
    "\n",
    "We need to request two dataframes, the ones that contains the history of all tokens (`all_content()`), and the one that containst the tokens that existed in a specific revision (`specific_rev_content_by_rev_id`)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "import pandas as pd\n",
    "from wikiwho_wrapper import WikiWho\n",
    "ww = WikiWho(lng='en')\n",
    "\n",
    "all_tokens_history = ww.dv.all_content(\"Bioglass 45S5\")\n",
    "specific_revision = ww.dv.specific_rev_content_by_rev_id(\n",
    "    article='Bioglass 45S5', rev_id=830824386)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 2. Merge the dataframes"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "df = pd.merge(\n",
    "    specific_revision, all_tokens_history[['token_id', 'in', 'out']], \n",
    "    how='left', on='token_id')\n",
    "df.head()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 3. Filtering the dataframe\n",
    "\n",
    "At this point we could apply any of the new operations learn in the last tutorial. However, we need to consider that all token history is present in the current revision. \n",
    "\n",
    "**Since this is a revision of the past, we would still see the revisions made for token in the future**.\n",
    "\n",
    "Let's remove all future revisions from `in` and `out` (depends on the assumptions that wikipedia revisions ids are incremental and sorted by time):"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "df = df[(df['in'] <= 830824386)]\n",
    "df.loc[df['out'] > 830824386,'out'] = -1\n",
    "df.head(10)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from utils.notebooks import get_next_notebook\n",
    "from IPython.display import HTML\n",
    "try:\n",
    "    display(HTML(f'<a href=\"{get_next_notebook()}\" target=\"_blank\">Go to next workbook</a>'))\n",
    "except:\n",
    "    HTML('<a href=\"5. Editor actions per page.ipynb\" target=\"_blank\">Go to next workbook</a>')"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.5"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}