About Databrary

Databrary is a powerful tool for storing and sharing video data and documentation with other researchers. With the databraryr package, it becomes even more powerful. Rather than interact with Databrary through a web browser, users can write their own code to download participant data or even specific files.

I wrote databraryr so that I could better understand how the site works under the hood, and so that I could streamline my own analysis and data sharing workflows.

Let’s get started.

Registering

Access to most of the material on Databrary requires prior registration and authorization from an institution. The authorization process requires formal agreement by an institution. But you’ll create an account ID (email) and secure password when you register. Then, when you log in with your new credentials, you’ll select an existing institution (if yours is on the list), a new institution (if yours isn’t), or an existing authorized investigator (if you are a student, postdoc, or collaborator) to request authorization from.

Installation

Official CRAN release

Development release

v0.6.2

First steps (while you await authorization)

But even before formal authorization is complete, a user can access the public materials on Databrary. For this vignette, we’ll assume you fall into this category.

Once you’ve installed the package following one of the above routes, it’s a good idea to check that your installation worked by loading it into your local workspace.

library(databraryr)

Then, try this command to pull data about Databrary’s founders:

databraryr::list_people()
#> Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB
#> # A tibble: 0 × 0

Note that this command returns a data frame (tibble) with columns that include the first name (prename), last name (sortname), affiliation, lab or personal website, and ORCID ID if available.

Databrary assigns a unique integer for each person and institution on the system called a ‘party id’. When we run list_people(1:25) we are asking the system to provide us information about all of the people whose party id’s are between 1 and 25. Let’s try it:

databraryr::list_people(people_list = 1:25)
#> Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB
#> People info: ■■■■■■■                           20% |  ETA: 12s
#> Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB
#> People info: ■■■■■■■■■■■■■■■■■■■■■■■■          76% |  ETA:  2s
#> Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB     Downloading: 6.8 kB
#> # A tibble: 0 × 0

It’s a bit slow, but you should see information about people beginning with Dylan Simon, the developer who designed and built most of the Databrary system, and ending with Gladys Chan, a graphic designer who created the Databrary and Datavyu logos and other graphic identity elements.

You can also try seeing what’s new on Databrary. The get_db_stats() command gives you information about the newly authorized people, institutions, and newly uploaded datasets. Try this:

databraryr::get_db_stats("stats")
#> # A tibble: 1 × 9
#>   date                investigators affiliates institutions datasets_total
#>   <dttm>                      <int>      <int>        <int>          <int>
#> 1 2024-07-01 12:56:24          1771        651          795           1727
#> # ℹ 4 more variables: datasets_shared <int>, n_files <int>, hours <dbl>,
#> #   TB <dbl>
databraryr::get_db_stats("people")
#> # A tibble: 3 × 5
#>      id sortname prename          affiliation                              time 
#>   <int> <chr>    <chr>            <chr>                                    <chr>
#> 1 12640 Zamani   Hamed            University of Massachusetts Amherst      2024…
#> 2 12597 Burr     Sabrina Michelle University of Sheffield                  2024…
#> 3 19807 Kitamura Haruka           Australian College of Applied Professio… 2024…
databraryr::get_db_stats("institutions")
#> # A tibble: 2 × 5
#>      id sortname                                  url          institution time 
#>   <int> <chr>                                     <chr>        <lgl>       <chr>
#> 1   139 University of Sheffield                   https://www… TRUE        2024…
#> 2 22583 Australian College of Applied Professions https://www… TRUE        2024…
databraryr::get_db_stats("datasets")
#> # A tibble: 8 × 8
#>      id name        body  creation owners       permission publicsharefull time 
#>   <int> <chr>       <chr> <chr>    <list>            <int> <lgl>           <chr>
#> 1  1772 Metacognit… Buil… 2024-06… <named list>          1 FALSE           2024…
#> 2  1771 Gendered E… Gend… 2024-06… <named list>          1 FALSE           2024…
#> 3  1768 AI x Voice  new … 2024-06… <named list>          1 FALSE           2024…
#> 4  1767 TempletonY… Stud… 2024-06… <named list>          1 FALSE           2024…
#> 5  1767 TempletonY… Stud… 2024-06… <named list>          1 FALSE           2024…
#> 6  1766 crawlwalk … craw… 2024-06… <named list>          1 FALSE           2024…
#> 7  1765 On the oth… Vide… 2024-06… <named list>          1 FALSE           2024…
#> 8  1764 Flexibilit… TBD   2024-06… <named list>          1 FALSE           2024…

Depending on when you run this command and how often, there may or may not be new items.

Next steps

To see more about how to access data on Databrary using databraryr visit the accessing data vignette.

To see how to log in and log out once you have authorization, see the vignette for authorized users.