User Input Generator.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 44,
   "metadata": {},
   "outputs": [],
   "source": [
    "import numpy as np\n",
    "import pandas as pd\n",
    "import random"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# User Input Generator"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The purpose of this ipynb is to create functions that will allow the generation of (fake) user inputs based on a given `agreement` value. The `agreement` value is a probabilty (between 0 and 1, inclusive)."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Functions"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### A single question with multiple (pseudo) user answers -- aka multiple users"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "\n",
    "Inputs\n",
    "- `choices`: the list of possible answer choices as strings\n",
    "- `consensus`: the consensus answer(s) as a list. Must be included in `choices`\n",
    "- `agreement`: the list of probabilities that each individual user agrees with the consensus (between 0 and 1, a double)\n",
    "- `numAnswers`: the number of possible answers to the question. A tuple of 2 integers, which correspond to the range of the number of possible answers. Cannot be greater than the total number of choices. Cannot have 0 answer choices possible. Example: (1, 1) means that there is 1 answer; (2, 5) means that there is 2 to 5 answers.\n",
    "\n",
    "Output\n",
    "- the user answers as a list of lists\n",
    "\n",
    "Note: `SingleQuestionSingleUser` has been condensed into this one function since `agreement` of length 1 is equivalent to 1 user."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 45,
   "metadata": {},
   "outputs": [],
   "source": [
    "def SingleQuestionMultUsers(choices, consensus, agreement, numAnswers):\n",
    "    answers = []\n",
    "    for a in agreement:\n",
    "        # TODO: Rethink where to put the checks/function design so that they are only run once for optimal runtime\n",
    "        choicesCopy = choices.copy()\n",
    "        if type(numAnswers[0]) != int or type(numAnswers[1]) != int:\n",
    "            raise ValueError(\"Number of answers must be integers.\")\n",
    "        if numAnswers[0] > numAnswers[1] or numAnswers[1] > len(choicesCopy) or numAnswers[0] <= 0:\n",
    "            raise ValueError(\"Please check the range of number of possible answers.\")\n",
    "\n",
    "        for c in consensus:\n",
    "            if not c in choicesCopy:\n",
    "                raise ValueError(\"Value(s) in `consensus` must be in `choices`.\")\n",
    "\n",
    "        value = np.random.random()\n",
    "        if value <= a:\n",
    "            z = consensus\n",
    "        else:\n",
    "            numAns = np.random.randint(numAnswers[0], numAnswers[1] + 1)\n",
    "            choicesCopy.remove(random.sample(consensus, 1)[0])\n",
    "            if numAns > len(choicesCopy):\n",
    "                numAns = len(choicesCopy)\n",
    "            z = random.sample(choicesCopy, numAns)\n",
    "        \n",
    "        answers.append(z)\n",
    "        \n",
    "    return answers"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Multiple Questions & Multiple Users"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Loop over `SingleQuestionMultUsers`.\n",
    "\n",
    "Inputs\n",
    "- `choices`: the list of lists of possible answer choices as strings\n",
    "- `consensus`: the consensus answer(s) as a list of lists. Must be included in `choices`\n",
    "- `agreement`: the list of probabilities that each individual user agrees with the consensus (between 0 and 1, a double)\n",
    "- `numQuestions`: the number of questions, should be equivalent to `len(choices)` and `len(consensus)`\n",
    "- `numAnswers`: the number of possible answers to the question. A list of tuples of 2 integers, which correspond to the range of the number of possible answers. Cannot be greater than the total number of choices. Cannot have 0 answer choices possible. Example: (1, 1) means that there is 1 answer; (2, 5) means that there is 2 to 5 answers.\n",
    "\n",
    "Output\n",
    "- the user answers as a list of lists of lists"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 46,
   "metadata": {},
   "outputs": [],
   "source": [
    "def MultQuestionMultUsers(choices, consensus, agreement, numQuestions, numAnswers):\n",
    "    if numQuestions != len(choices) or len(choices) != len(consensus) or len(consensus) != len(numAnswers):\n",
    "        raise ValueError(\"Number of questions is not reflected in either `choices` or `consensus` or `numAnswers` or some combination.\")\n",
    "    \n",
    "    answers = []\n",
    "    for i in range(numQuestions):\n",
    "        answers.append(SingleQuestionMultUsers(choices[i], consensus[i], agreement, numAnswers[i]))\n",
    "    return answers"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### ToDataFrame"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Function to convert the result of `MultQuestionMultUsers` into a Pandas DataFrame for easier reading & analysis.\n",
    "\n",
    "Input:\n",
    "- `questionNames`: names of the questions, aka the question labels\n",
    "- `user`: list of user id's\n",
    "- `data`: the output of `MultQuestionMultUsers`\n",
    "\n",
    "Output: \n",
    "- a pandas DataFrame"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 47,
   "metadata": {},
   "outputs": [],
   "source": [
    "def toDataFrame(questions, choices, user, data):\n",
    "    if len(questions) != len(choices): \n",
    "        raise ValueError(\"Number of questions do not match for `questions` and `choices`\")\n",
    "        \n",
    "    questionLabels = []\n",
    "    for i in range(len(questions)):\n",
    "        for c in range(len(choices[i])):\n",
    "            questionLabels.append(questions[i] + \".\" + str(c+1))\n",
    "\n",
    "    df = pd.DataFrame(data, index = questions, columns = user).T\n",
    "\n",
    "    dfClean = pd.DataFrame([], index = user, columns = questionLabels)\n",
    "\n",
    "    for q in questions:\n",
    "        for c in choices:\n",
    "            for u in user:\n",
    "                chosen = df[q][u]\n",
    "                for ch in chosen:\n",
    "                    questionNumber = questions.index(q)\n",
    "                    questionChoiceNumber = choices[questionNumber].index(ch) + 1\n",
    "                    dfClean[q + \".\" + str(questionChoiceNumber)][u] = 1\n",
    "\n",
    "    dfClean.fillna(0, inplace = True)\n",
    "    \n",
    "    return dfClean"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Notes"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "- How to redesign functions so that the checks are only done once. \n",
    "- Consider the output of MultQMultU: a list of lists of lists is . . . very confusing\n",
    "- Look up how to write a pandas dataframe as a csv\n",
    "- Does not consider questions that are left unanswered."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Example Pseudo Data"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 50,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>Q1.1</th>\n",
       "      <th>Q1.2</th>\n",
       "      <th>Q1.3</th>\n",
       "      <th>Q1.4</th>\n",
       "      <th>Q1.5</th>\n",
       "      <th>Q2.1</th>\n",
       "      <th>Q2.2</th>\n",
       "      <th>Q2.3</th>\n",
       "      <th>Q3.1</th>\n",
       "      <th>Q3.2</th>\n",
       "      <th>Q4.1</th>\n",
       "      <th>Q4.2</th>\n",
       "      <th>Q4.3</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>uuid01</th>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid02</th>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid03</th>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid04</th>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid05</th>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid06</th>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid07</th>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid08</th>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid09</th>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid10</th>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid11</th>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid12</th>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid13</th>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid14</th>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid15</th>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid16</th>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid17</th>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid18</th>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid19</th>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>uuid20</th>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>1</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "        Q1.1  Q1.2  Q1.3  Q1.4  Q1.5  Q2.1  Q2.2  Q2.3  Q3.1  Q3.2  Q4.1  \\\n",
       "uuid01     1     0     0     1     0     0     1     0     0     1     0   \n",
       "uuid02     1     1     0     0     0     0     0     1     1     0     0   \n",
       "uuid03     0     0     0     1     0     0     0     1     0     1     0   \n",
       "uuid04     1     0     1     1     0     1     0     0     1     0     1   \n",
       "uuid05     1     1     0     0     0     1     0     0     1     0     1   \n",
       "uuid06     0     0     1     0     0     0     1     0     1     0     0   \n",
       "uuid07     0     0     1     0     1     0     1     0     0     1     1   \n",
       "uuid08     1     1     0     0     0     0     1     0     1     0     0   \n",
       "uuid09     1     1     0     0     0     1     0     0     1     0     0   \n",
       "uuid10     1     1     0     0     0     1     0     0     1     0     1   \n",
       "uuid11     0     0     0     1     0     0     0     1     1     0     0   \n",
       "uuid12     1     1     0     0     0     1     0     0     1     0     1   \n",
       "uuid13     1     1     0     0     0     0     1     0     0     1     1   \n",
       "uuid14     1     1     0     0     0     1     0     0     1     0     1   \n",
       "uuid15     1     1     0     0     0     0     1     0     1     0     1   \n",
       "uuid16     1     1     0     0     0     1     0     0     1     0     1   \n",
       "uuid17     0     0     0     0     1     0     0     1     0     1     1   \n",
       "uuid18     1     0     1     0     1     0     1     0     0     1     1   \n",
       "uuid19     1     1     0     0     0     1     0     0     1     0     1   \n",
       "uuid20     1     0     0     1     0     1     0     0     0     1     1   \n",
       "\n",
       "        Q4.2  Q4.3  \n",
       "uuid01     1     0  \n",
       "uuid02     0     1  \n",
       "uuid03     0     1  \n",
       "uuid04     1     0  \n",
       "uuid05     1     0  \n",
       "uuid06     1     0  \n",
       "uuid07     1     0  \n",
       "uuid08     0     1  \n",
       "uuid09     1     0  \n",
       "uuid10     1     0  \n",
       "uuid11     1     0  \n",
       "uuid12     1     0  \n",
       "uuid13     1     0  \n",
       "uuid14     0     0  \n",
       "uuid15     1     0  \n",
       "uuid16     1     0  \n",
       "uuid17     1     0  \n",
       "uuid18     1     0  \n",
       "uuid19     0     0  \n",
       "uuid20     1     0  "
      ]
     },
     "execution_count": 50,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "choices = [[\"1\", \"2\", \"3\", \"4\", \"5\"], [\"yes\", \"no\", \"maybe\"], [\"of course\", \"no way\"], [\"a fallacy\", \"possible fallacy\", \"no fallacy\"]]\n",
    "consensus = [[\"1\", \"2\"], [\"yes\"], [\"of course\"], [\"a fallacy\", \"possible fallacy\"]]\n",
    "agreement = [0.1, 0.5, 0.4, 0.8, 0.88, 0.09, 0.35, 0.4, 0.77, 0.8, 0.5, 0.5, 0.4, 0.8, 0.88, 0.89, 0.35, 0.4, 0.77, 0.8]\n",
    "numQuestions = 4\n",
    "numAnswers = [(1, 3), (1, 1), (1, 1), (1, 1)]\n",
    "data = MultQuestionMultUsers(choices, consensus, agreement, numQuestions, numAnswers)\n",
    "\n",
    "questions = [\"Q1\", \"Q2\", \"Q3\", \"Q4\"]\n",
    "user = [\"uuid01\", \"uuid02\", \"uuid03\", \"uuid04\", \"uuid05\", \"uuid06\", \"uuid07\", \"uuid08\", \"uuid09\", \"uuid10\", \n",
    "        \"uuid11\", \"uuid12\", \"uuid13\", \"uuid14\", \"uuid15\", \"uuid16\", \"uuid17\", \"uuid18\", \"uuid19\", \"uuid20\"]\n",
    "toDataFrame(questions, choices, user, data)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "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.7.4"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}