mctq
utility functions will begin. Please pay attention to
the deprecation warnings listed below.random_mctq()
to avoid
warning messages due to lubridate
package updates.assign_date()
,
cycle_time()
, round_time()
,
shorter_interval()
, longer_interval()
,
shorter_duration()
, longer_duration()
,
sum_time()
, and vct_sum_time()
are now
deprecated. These functions will be removed on the next
mctq
version. You can still find them in the lubritime
package.qplot_walk()
is now deprecated.
This function will be removed on the next mctq
version. You
can still find it in the gutils
package.qplot_walk()
now uses ggplot2::geom_bar()
or ggplot2::geom_histogram()
to generate plots. It used
ggplot2::qplot()
before, now deprecated.ggplot2
package was added as an import. It’s needed
while qplot_walk()
remains on the package and will be
removed from imports in the next mctq
version.mctq
development, but are not part of the mctq
project anymore.mctq
) is no longer part of this group. The “funder” status
was always symbolic.mctq
has been self-certified on the OpenSSF Best
Practices Badge Program.chronotype()
, a wrapper function for
msf_sc()
, was removed.shorter_interval()
now don’t have the
inverse
argument. Use longer_interval()
instead.shorter_duration()
and longer_duration()
,
two functions that return the shorter and the longer duration between
two hours, were introduced.sjl_sc()
and sjl_sc_rel()
, two functions
that allow the user to compute Jankowski’s MCTQ sleep-corrected social
jet lag, were introduced.mctq
with
install.packages("mctq")
.1.0.0
(stable) mctq
version. We don’t intend
to make any breaking changes, but we think is better to wait and see if
the user community don’t have any issues with the features.mctq
is now a peer-reviewed
package by @ropensci! 🎉mctq
have been changed. Old links have a redirect
protocol to point to the new repository and new website.assign_date()
now returns only Interval
objects.convert()
and all convert_*()
functions
were removed. See a dedicated note about this below.ms()
was renamed to msl()
. See a dedicated
note about this below.sd()
was renamed to sdu()
. See a dedicated
note about this below.shortest_interval()
was renamed to
shorter_interval()
.shorter_interval()
and longer_interval()
now returns only Interval
objects.sum_time()
now have different arguments and was divided
in two functions: sum_time()
(for non-vectorized sums) and
vct_sum_time()
(for vectorized sums).sum_time()
now returns only Duration
objects.cycle_time()
, a function to cycle time spans, was
introduced.round_time()
is now a S3 generic.cli
package (now on
imports).mctq
package use Duration
instead of Period
(objects from the lubridate package) as the
default object for time spans.convert()
convert()
was created considering the user experience
(sleep and chronobiology scientists). Since most of them don’t have much
experience with R and that time can have different types of
representations (e.g., decimal hours, radian), convert()
aim was to help transpose those difficulties, posing as an “universal
translator” (🖖).
However, after much thought and consideration, we believe that the
convert()
feature may be out of the mctq
scope. It can maybe be part of another package (a lubritime
package perhaps? 😄). Other mctq
tools, like
shorter_interval()
and sum_time()
, could also
be a part of that package (but are necessary in mctq
for
the time being). Hence, we decided to remove convert()
and
to instruct the user to check the lubridate and hms packages for
parsing/conversion.
sd()
and ms()
That was a tough, but necessary, call. Although we tried to preserve
the original author’s naming pattern for the MCTQ functions, the name
sd
provokes a dangerous name collision with the widely used
stats::sd()
function (standard deviation) and the name
ms
provokes a name collision with
lubridate::ms()
(a function for parsing minutes and seconds
components). That’s why we decided to renamed them. sdu()
and msl()
are the only exceptions, all the other
mctq
functions maintain a strong naming resemblance with
the original author’s naming pattern.
NEWS.md
file to track changes to the
package.