Sleep Data Filtering and Visualisation

---

Documentation for package ‘nocturn’ version 1.1.3

• DESCRIPTION file.
• Package NEWS.

Help Pages

check_suggests	Check whether suggested packages are installed
chronotype	Calculate the Chronotype
clean_epochs	Clean epoch data
clean_sessions	Clean session data
composite_phase_deviation	Calculate Composite Phase Deviation (CPD)
example_epochs	Example Epoch data
example_epochs_v1	Example Epoch data (Somnofy API v1)
example_sessions	Example Sessions data
example_sessions_v1	Example Sessions data (Somnofy API v1)
filter_by_age_range	Filter sessions by age range
filter_by_night_range	Filter sessions for nights within a night range
filter_by_sex	Filter by sex
filter_epochs_from_sessions	Filter epochs based on session IDs
get_col	Get a column from a dataframe safely
get_colnames	Get standard column names for a data frame (sessions or epochs)
get_epochs_summary	Summarise epoch information
get_epoch_colnames	Get a list of standard column names for epochs data
get_non_complying_sessions	Get non-complying sessions (i.e. where there is more than one session on the same day)
get_removed_sessions	Get a table of sessions that were removed during filtering
get_sessions_summary	Make a summary of session information
get_session_colnames	Get a list of standard column names for sessions data
get_time_per_day	Calculate the number of time units in a day
group_epochs_by_night	Create a grouping by night for epoch data
group_sessions_by_night	Create a grouping by night for session data
interdaily_stability	Calculate Interdaily Stability (IS)
is_iso8601_datetime	Check if a column contains ISO 8601 datetime strings
load_batch	Load session or epoch data in batch mode
load_epochs	Load epoch data
load_sessions	Load session data
max_time	Calculate the maximum time from 12pm to 12pm
mean_time	Calculate the mean time from a vector of time strings
min_time	Calculate the minimum time from 12pm to 12pm
nocturn	nocturn app
parse_date	Parse a vector of date strings into Date objects
parse_time	Parse a vector of time strings into POSIXct objects
plot_bedtimes_waketimes	Plot bedtimes and waketimes
plot_hypnogram	Plot Hypnogram
plot_sleep_bubbles	Plot Sleep Bubbles
plot_sleep_clock	Plot Sleep Clock
plot_sleep_spiral	Plot Sleep Spiral
plot_timeseries	Plot epoch time series data for a given variable
plot_timeseries_sessions	Plot session time series data for a given variable
read_edf_epochs	Read EDF Epochs
read_edf_sessions	Read EDF Sessions
remove_sessions_no_sleep	Remove sessions with no sleep
sd_time	Calculate the circular standard deviation of a vector of times
select_devices	Select devices by ID
select_subjects	Select subjects by ID
set_colnames	Set column names for a data frame (sessions or epochs)
set_data_type	Set the type attribute for a data frame
set_min_sleep_period	Set minimum sleep period
set_min_time_in_bed	Set minimum time in bed
set_session_sleep_onset_range	Set sleep onset time range
set_session_start_time_range	Set session start time range
shift_times_by_12h	Shift times to break at 12 pm
sleeptimes_boxplot	Plot boxplots for sleep onset, midsleep, and wakeup times
sleeptimes_density	Plot density curves for sleep onset, midsleep, and wakeup times with a dashed line showing the median
sleeptimes_histogram	Plot histograms for sleep onset, midsleep, and wakeup times
sleep_regularity_index	Calculate the Sleep Regularity Index (SRI)
sleep_report	Generate a patient sleep report in PDF format
social_jet_lag	Calculate Social Jet Lag
time_diff	Compute the forward time difference from t1 to t2 (wrapping at 24)
time_to_hours	Convert time vector to numeric hours
update_date	Update the date component of a POSIXct time object