README.md

In WillMeyerson/BEDDiT: Bedtime Estimation from the Diurnal Distribution in Timestamps on Reddit

`This R package trains, tests, and applies models for inferring Reddit user bedtimes in the manner of https://formative.jmir.org/2023/1/e38112

Installation:

To install, first ensure devtools is installed install.packages("devtools") library(devtools)

Then install the BEDDiT package install_github("WillMeyerson/BEDDiT") library(BEDDiT)

Use:

Most users will only be interested in two functions: bin_beddit() and apply_beddit()

bin_beddit() is a pre-processing helper script that converts raw tab-delimited Reddit data into the "circadian fingerprint" format expected of core pipeline functions.

apply_beddit() is the main function for casual users of the R package. It predicts a set of Reddit users' bedtimes from their circardian fingerprints

There are an additional functions to make it convenient for users who want to train and test their own Reddit bedtime estimation models, or more deeply understand the mechanics of the package.

Please note that it is expected that the apply_beddit() function will be updated in the future to reflect simplifications in the workflow since the original compiling of the pacakge.

Researchers interested in the pre-computed bedtime estimates of 50,000 users from the manuscript should write to [e-mail] where name1="william" and name2="ulysses" to receive access to a data usage agreement in preparation for the file share.

WillMeyerson/BEDDiT documentation built on Feb. 2, 2023, 6:37 p.m.