Merge pull request #67 from datapages/comps

Comps

Author: ben-domingue

_quarto.yml

@@ -26,6 +26,10 @@ website:
           text: Data Documentation
         - href: itemtext.qmd
           text: Item Text
+      - text: "Competitions"
+        menu:
+        - href: comps_standard.qmd
+          text: The Competition Data Standard
       - text: "More"
         menu:
         - href: research.qmd

comps_standard.qmd

@@ -0,0 +1,32 @@
+---
+title: "The Competition Data Standard"
+---
+
+Note: This is an experimental feature.
+
+## The data standard
+
+The IRW competition data standard is meant to describe data derived from pairwise comparisons or competitions. Such data are widely analyzed using ELO or Bradley-Luce-Terry approaches; more information about these approaches is available [here](https://www.annualreviews.org/content/journals/10.1146/annurev-statistics-040722-061813). The key distinction between these data and the conventional IRW data is that there are not `id` and `item` identifiers here but rather identifers of the two `agents` that are involved in a given competition.
+
+- `agent_a` name/id of first competitor
+- `agent_b` name/id of second competitor
+- `date` Time of the data point in UNIX format.
+- `homefield` Indicator of agent that had advantage based on game features (e.g., where game was played, who played first, etc).
+- `score_a` Score of `agent_a`.
+- `score_b` Score of `agent_b`.
+- `winner` Winner of the competition (typically based on a comparison of scores). Values will be `agent_a`, `agent_b` or `draw`.
+
+
+## Accessing the competition data
+
+The competitions data can be easily accessed via the `irw` R package:
+```{r}
+#| eval: false
+#| echo: true
+
+# Install and load the package
+df <- irw::irw_fetch("collegefb_2021and2022", comp = TRUE)
+head(df)
+```
+
+Documentation related to the tables (including table names as with `collegefb_2021and2022`) can be found [here](https://docs.google.com/spreadsheets/d/1WZZYyVC2cmw8CUJM69qP0F_ZlQjQfdkCZbdsG-8mUrs/edit?usp=sharing).

renv.lock

@@ -740,7 +740,7 @@
         "stats",
         "tibble"
       ],
-      "Hash": "8639bed29649d9af0f4abcc65dde9f94"
+      "Hash": "bd79e7714e4abd3930a746664f728581"
     },
     "jquerylib": {
       "Package": "jquerylib",
@@ -1128,14 +1128,14 @@
     },
     "redivis": {
       "Package": "redivis",
-      "Version": "0.11.8",
+      "Version": "0.11.9",
       "Source": "GitHub",
       "RemoteType": "github",
       "RemoteHost": "api.github.com",
-      "RemoteRepo": "redivis-r",
       "RemoteUsername": "redivis",
+      "RemoteRepo": "redivis-r",
       "RemoteRef": "main",
-      "RemoteSha": "077c906c64883242f2a5c3df10f2e3c8d4d4d9cb",
+      "RemoteSha": "0359c91c29bcd65074354d7166bcee5985a9995f",
       "Requirements": [
         "R",
         "arrow",
@@ -1152,7 +1152,7 @@
         "tibble",
         "uuid"
       ],
-      "Hash": "0febbbb2b4e4f904fbc72031ad7e7307"
+      "Hash": "2de262c21b2c2a555989564fb274f7b7"
     },
     "renv": {
       "Package": "renv",