{"Package":"dttr2","Title":"Manipulate Date, POSIXct and hms Vectors","Version":"0.5.2","Authors@R":"c(\nperson(\"Joe\", \"Thorley\", , \"joe@poissonconsulting.ca\", role = \"aut\",\ncomment = c(ORCID = \"0000-0002-7683-4592\")),\nperson(\"Ayla\", \"Pearson\", , \"ayla@poissonconsulting.ca\", role = c(\"aut\", \"cre\"),\ncomment = c(ORCID = \"0000-0001-7388-1222\")),\nperson(\"Poisson Consulting\", role = c(\"cph\", \"fnd\"))\n)","Description":"Manipulates date ('Date'), date time ('POSIXct') and time\n('hms') vectors. Date/times are considered discrete and are floored\nwhenever encountered. Times are wrapped and time zones are maintained\nunless explicitly altered by the user.","License":"MIT + file LICENSE","URL":"https://github.com/poissonconsulting/dttr2,\nhttps://poissonconsulting.github.io/dttr2/","BugReports":"https://github.com/poissonconsulting/dttr2/issues","Depends":"R (>= 4.0)","Imports":"chk (>= 0.9.1), hms, lifecycle","Suggests":"rlang, spelling, testthat (>= 3.0.0)","RdMacros":"lifecycle","Config/testthat/edition":"3","Encoding":"UTF-8","Language":"en-US","RoxygenNote":"7.3.2","NeedsCompilation":"no","Packaged":"2024-09-25 23:40:09 UTC; aylapearson","Author":"Joe Thorley [aut] (),\nAyla Pearson [aut, cre] (),\nPoisson Consulting [cph, fnd]","Maintainer":"Ayla Pearson ","Repository":"CRAN","Date/Publication":"2024-09-26 00:00:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/dttr2_0.5.2.tar.gz","jsonAuthors":[{"name":"Joe Thorley","email":"joe@poissonconsulting.ca","maintainer":false},{"name":"Ayla Pearson","email":"ayla@poissonconsulting.ca","maintainer":true},{"name":"Poisson Consulting ","email":null,"maintainer":false}],"readme":"\n\n\n# dttr2

\n\n\n\n[![Lifecycle:\nstable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)\n[![R-CMD-check](https://github.com/poissonconsulting/dttr2/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/poissonconsulting/dttr2/actions/workflows/R-CMD-check.yaml)\n[![Codecov test\ncoverage](https://codecov.io/gh/poissonconsulting/dttr2/graph/badge.svg)](https://app.codecov.io/gh/poissonconsulting/dttr2)\n[![License:\nMIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/license/MIT)\n[![CRAN\nstatus](https://www.r-pkg.org/badges/version/dttr2)](https://cran.r-project.org/package=dttr2)\n![CRAN downloads](http://cranlogs.r-pkg.org/badges/dttr2)\n\n\n## Introduction\n\n`dttr2` (Dates, Times and dateTimes in R) is an R package to perform\nsimple manipulations on date (Date), datetime (POSIXct) and time (hms)\nvectors (collectively referred to as date/times).\n\nKey design principles include\n\n1. use existing classes (Date, POSIXct, hms)\n2. date/times are discrete (floor when encountered)\n3. times are times (wrap when encountered)\n4. maintain the current timezone (principle of least astonishment)\n5. the origin is always assumed to be 1970-01-01 UTC (keep it simple)\n\n## Installation\n\nTo install the latest release version from\n[CRAN](https://cran.r-project.org/package=dttr2)\n\n install.packages(\"dttr2\")\n\nTo install the latest development version from\n[GitHub](https://github.com/poissonconsulting/dttr2)\n\n # install.packages(\"pak\")\n pak::pak(\"poissonconsulting/dttr2\")\n\n## Introduction\n\n### Time Units\n\n`dttr2` floors any date/time objects it encounters to the nearest time\nunit (by default days for Date and seconds for POSIXct and hms).\n\n``` r\nlibrary(dttr2)\ndate <- as.Date(1.75, origin = \"1970-01-01\")\ndate\n#> [1] \"1970-01-02\"\nas.numeric(date)\n#> [1] 1.75\n\ndate <- dtt_date(date)\ndate\n#> [1] \"1970-01-02\"\nas.numeric(date)\n#> [1] 1\n```\n\nSimilarly, the time unit accessor (`dtt_second()`, `dtt_minute()` etc)\nand settor functions as well as the functions to add (ie\n`dtt_add_seconds()`) and subtract time units return or require integers.\n\n``` r\ndtt_day(date)\n#> [1] 2\ndtt_add_days(date, 2L)\n#> [1] \"1970-01-04\"\ndtt_add_months(date, 24L)\n#> [1] \"1972-01-02\"\n```\n\n### Times\n\n`dttr2` wraps negative times or times greater than 23:59:59 to the\nactual clock time.\n\n``` r\ntime <- hms::as_hms(-3)\ntime\n#> -00:00:03\ndtt_time(time)\n#> 23:59:57\ndtt_time(hms::as_hms(\"24:00:00\"))\n#> 00:00:00\n```\n\n### Time Zones\n\nThe user can override the default time zone (UTC) when handling POSIXct\nvectors using `dtt_set_default_tz()`.\n\n``` r\ndtt_default_tz()\n#> [1] \"UTC\"\ndate_time <- dtt_date_time(\"1970-01-01 03:00:00\")\ndtt_set_default_tz(\"Etc/GMT+10\")\ndtt_default_tz()\n#> [1] \"Etc/GMT+10\"\ndate_time\n#> [1] \"1970-01-01 03:00:00 UTC\"\n```\n\nThey can assign a new time zone to a POSIXct object whilst leaving the\nclock time unchanged using `dtt_set_tz()` or adjust the time zone so\nthat clock (but not the actual) time is altered using `dtt_adjust_tz()`\n\n``` r\ndate_time\n#> [1] \"1970-01-01 03:00:00 UTC\"\ndtt_set_tz(date_time)\n#> [1] \"1970-01-01 03:00:00 -10\"\ndtt_adjust_tz(date_time)\n#> [1] \"1969-12-31 17:00:00 -10\"\n```\n\n### Combining Dates and Times\n\n`dttr2` makes it easy to decompose POSIXct vectors into Date and hms\nvectors and then recombine them again.\n\nAs neither dates nor times have associated time zones unless the user\npasses a value they are assigned the default time zone.\n\n``` r\ndate_time\n#> [1] \"1970-01-01 03:00:00 UTC\"\ndate <- dtt_date(date_time)\ndate\n#> [1] \"1970-01-01\"\ntime <- dtt_time(date_time)\ntime\n#> 03:00:00\ndtt_date_time(date, time)\n#> [1] \"1970-01-01 03:00:00 -10\"\n```\n\n## Inspiration\n\ndttr2 was influenced by [lubridate](https://lubridate.tidyverse.org). It\naims to provide an alternative for simple manipulations.\n\n## Contribution\n\nPlease report any\n[issues](https://github.com/poissonconsulting/dttr2/issues).\n\n[Pull requests](https://github.com/poissonconsulting/dttr2/pulls) are\nalways welcome.\n\n## Code of Conduct\n\nPlease note that the dttr2 project is released with a [Contributor Code\nof\nConduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).\nBy contributing to this project, you agree to abide by its terms.","jobInfo":{"package":"dttr2","version":"0.5.2","parsingStatus":"success","parserVersion":2,"parsedAt":"2024-09-26T02:29:48+0000"}}

Description

Usage

Arguments

Format