updated documentation, most are good shape except cohorts and calendar_types. non-standard calendar still needs testing. estimate 2 committed days to close this out completely. priority should be to close out documentation and (0.5 days) test calendar types (1.5 days). then need to move this over to fpa with clean version and can open up enhacements down the road

Author: usrbinr

R/utils-misc.R

@@ -221,7 +221,6 @@ print_actions_steps <- function(x){
 
 augment_standard_calendar_tbl <- function(.data,.date){
 
-lubridate::days
   # create attibutes
   out <- .data |>
     dplyr::mutate(
@@ -316,7 +315,7 @@ augment_standard_calendar_dbi <- function(.data,.date){
 
   date_vec <- rlang::as_label(.date)
 
-# out <-
+out <-
   .data |>
   dplyr::mutate(
     year_start_date=lubridate::floor_date({{.date}},unit = "year")
@@ -351,6 +350,8 @@ augment_standard_calendar_dbi <- function(.data,.date){
     dplyr::across(dplyr::contains("date"),\(x) as.Date(x))
   )
 
+return(out)
+
 }
 
 
@@ -419,6 +420,8 @@ augment_standard_calendar <- function(.data,.date){
 
     out <- augment_standard_calendar_dbi(.data = .data,.date = .date_var)
 
+    return(out)
+
 
   }
 
@@ -427,11 +430,11 @@ augment_standard_calendar <- function(.data,.date){
 
     out <- augment_standard_calendar_tbl(.data = .data,.date = !!.date_var)
 
+    return(out)
   }
 
 
 
-
 }
 
 
@@ -630,7 +633,6 @@ augment_non_standard_calendar <- function(.data,pattern){
 }
 
 
-
 utils::globalVariables(
   c(
     "desc",

_pkgdown.yml

@@ -58,3 +58,4 @@
         - yoy        # year-over-year (full)
         - yoytd      # YTD vs prior YTD
         - ytdopy     # YTD over previous full year
+

renv.lock

@@ -213,7 +213,7 @@
     },
     "S7": {
       "Package": "S7",
-      "Version": "0.2.0",
+      "Version": "0.2.1",
       "Source": "Repository",
       "Title": "An Object Oriented System Meant to Become a Successor to S3 and S4",
       "Authors@R": "c( person(\"Object-Oriented Programming Working Group\", role = \"cph\"), person(\"Davis\", \"Vaughan\", role = \"aut\"), person(\"Jim\", \"Hester\", role = \"aut\", comment = c(ORCID = \"0000-0002-2739-7082\")), person(\"Tomasz\", \"Kalinowski\", role = \"aut\"), person(\"Will\", \"Landau\", role = \"aut\"), person(\"Michael\", \"Lawrence\", role = \"aut\"), person(\"Martin\", \"Maechler\", role = \"aut\", comment = c(ORCID = \"0000-0002-8685-9910\")), person(\"Luke\", \"Tierney\", role = \"aut\"), person(\"Hadley\", \"Wickham\", , \"[email protected]\", role = c(\"aut\", \"cre\"), comment = c(ORCID = \"0000-0003-4757-117X\")) )",
@@ -244,9 +244,9 @@
       "Config/testthat/parallel": "TRUE",
       "Config/testthat/start-first": "external-generic",
       "Encoding": "UTF-8",
-      "RoxygenNote": "7.3.2",
+      "RoxygenNote": "7.3.3",
       "NeedsCompilation": "yes",
-      "Author": "Object-Oriented Programming Working Group [cph], Davis Vaughan [aut], Jim Hester [aut] (<https://orcid.org/0000-0002-2739-7082>), Tomasz Kalinowski [aut], Will Landau [aut], Michael Lawrence [aut], Martin Maechler [aut] (<https://orcid.org/0000-0002-8685-9910>), Luke Tierney [aut], Hadley Wickham [aut, cre] (<https://orcid.org/0000-0003-4757-117X>)",
+      "Author": "Object-Oriented Programming Working Group [cph], Davis Vaughan [aut], Jim Hester [aut] (ORCID: <https://orcid.org/0000-0002-2739-7082>), Tomasz Kalinowski [aut], Will Landau [aut], Michael Lawrence [aut], Martin Maechler [aut] (ORCID: <https://orcid.org/0000-0002-8685-9910>), Luke Tierney [aut], Hadley Wickham [aut, cre] (ORCID: <https://orcid.org/0000-0003-4757-117X>)",
       "Maintainer": "Hadley Wickham <[email protected]>",
       "Repository": "CRAN"
     },
@@ -1537,7 +1537,7 @@
     },
     "duckdb": {
       "Package": "duckdb",
-      "Version": "1.4.1.9006",
+      "Version": "1.4.2.9003",
       "Source": "GitHub",
       "Title": "DBI Package for the DuckDB Database Management System",
       "Authors@R": "c( person(\"Hannes\", \"Mühleisen\", , \"[email protected]\", role = \"aut\", comment = c(ORCID = \"0000-0001-8552-0029\")), person(\"Mark\", \"Raasveldt\", , \"[email protected]\", role = \"aut\", comment = c(ORCID = \"0000-0001-5005-6844\")), person(\"Kirill\", \"Müller\", , \"[email protected]\", role = \"cre\", comment = c(ORCID = \"0000-0002-1416-3412\")), person(\"Stichting DuckDB Foundation\", role = \"cph\"), person(\"Apache Software Foundation\", role = \"cph\"), person(\"PostgreSQL Global Development Group\", role = \"cph\"), person(\"The Regents of the University of California\", role = \"cph\"), person(\"Cameron Desrochers\", role = \"cph\"), person(\"Victor Zverovich\", role = \"cph\"), person(\"RAD Game Tools\", role = \"cph\"), person(\"Valve Software\", role = \"cph\"), person(\"Rich Geldreich\", role = \"cph\"), person(\"Tenacious Software LLC\", role = \"cph\"), person(\"The RE2 Authors\", role = \"cph\"), person(\"Google Inc.\", role = \"cph\"), person(\"Facebook Inc.\", role = \"cph\"), person(\"Steven G. Johnson\", role = \"cph\"), person(\"Jiahao Chen\", role = \"cph\"), person(\"Tony Kelman\", role = \"cph\"), person(\"Jonas Fonseca\", role = \"cph\"), person(\"Lukas Fittl\", role = \"cph\"), person(\"Salvatore Sanfilippo\", role = \"cph\"), person(\"Art.sy, Inc.\", role = \"cph\"), person(\"Oran Agra\", role = \"cph\"), person(\"Redis Labs, Inc.\", role = \"cph\"), person(\"Melissa O'Neill\", role = \"cph\"), person(\"PCG Project contributors\", role = \"cph\") )",
@@ -1583,9 +1583,8 @@
       "RemoteHost": "api.github.com",
       "RemoteRepo": "duckdb-r",
       "RemoteUsername": "duckdb",
-      "RemotePkgRef": "duckdb/duckdb-r",
       "RemoteRef": "HEAD",
-      "RemoteSha": "e95be413e22c3017989177f069542964b4189e1c",
+      "RemoteSha": "0ed289d9ca6513dabe081e2cb0556046503243d6",
       "NeedsCompilation": "yes",
       "Author": "Hannes Mühleisen [aut] (ORCID: <https://orcid.org/0000-0001-8552-0029>), Mark Raasveldt [aut] (ORCID: <https://orcid.org/0000-0001-5005-6844>), Kirill Müller [cre] (ORCID: <https://orcid.org/0000-0002-1416-3412>), Stichting DuckDB Foundation [cph], Apache Software Foundation [cph], PostgreSQL Global Development Group [cph], The Regents of the University of California [cph], Cameron Desrochers [cph], Victor Zverovich [cph], RAD Game Tools [cph], Valve Software [cph], Rich Geldreich [cph], Tenacious Software LLC [cph], The RE2 Authors [cph], Google Inc. [cph], Facebook Inc. [cph], Steven G. Johnson [cph], Jiahao Chen [cph], Tony Kelman [cph], Jonas Fonseca [cph], Lukas Fittl [cph], Salvatore Sanfilippo [cph], Art.sy, Inc. [cph], Oran Agra [cph], Redis Labs, Inc. [cph], Melissa O'Neill [cph], PCG Project contributors [cph]",
       "Maintainer": "Kirill Müller <[email protected]>"
@@ -2704,7 +2703,7 @@
     },
     "janitor": {
       "Package": "janitor",
-      "Version": "2.2.0",
+      "Version": "2.2.1",
       "Source": "Repository",
       "Title": "Simple Tools for Examining and Cleaning Dirty Data",
       "Authors@R": "c(person(\"Sam\", \"Firke\", email = \"[email protected]\", role = c(\"aut\", \"cre\")), person(\"Bill\", \"Denney\", email = \"[email protected]\", role = \"ctb\"), person(\"Chris\", \"Haid\", email = \"[email protected]\", role = \"ctb\"), person(\"Ryan\", \"Knight\", email = \"[email protected]\", role = \"ctb\"), person(\"Malte\", \"Grosser\", email = \"[email protected]\", role = \"ctb\"), person(\"Jonathan\", \"Zadra\", email = \"[email protected]\", role = \"ctb\"))",
@@ -4968,7 +4967,7 @@
     },
     "stringr": {
       "Package": "stringr",
-      "Version": "1.5.2",
+      "Version": "1.6.0",
       "Source": "Repository",
       "Title": "Simple, Consistent Wrappers for Common String Operations",
       "Authors@R": "c( person(\"Hadley\", \"Wickham\", , \"[email protected]\", role = c(\"aut\", \"cre\", \"cph\")), person(\"Posit Software, PBC\", role = c(\"cph\", \"fnd\")) )",
@@ -4977,7 +4976,7 @@
       "URL": "https://stringr.tidyverse.org, https://github.com/tidyverse/stringr",
       "BugReports": "https://github.com/tidyverse/stringr/issues",
       "Depends": [
-        "R (>= 3.6)"
+        "R (>= 4.1.0)"
       ],
       "Imports": [
         "cli",
@@ -5001,10 +5000,11 @@
       ],
       "VignetteBuilder": "knitr",
       "Config/Needs/website": "tidyverse/tidytemplate",
+      "Config/potools/style": "explicit",
       "Config/testthat/edition": "3",
       "Encoding": "UTF-8",
       "LazyData": "true",
-      "RoxygenNote": "7.3.2",
+      "RoxygenNote": "7.3.3",
       "NeedsCompilation": "no",
       "Author": "Hadley Wickham [aut, cre, cph], Posit Software, PBC [cph, fnd]",
       "Maintainer": "Hadley Wickham <[email protected]>",

vignettes/articles/abc.qmd

@@ -8,17 +8,15 @@ subtitle: "How to use classification strategies to focus your analysis"
 #| echo: false
 
 library(fpaR)
-
 quarto::write_yaml_metadata_block(
    date=format(Sys.Date())
    )
 ```
 
 
-### Introduction
+In business and financial analytics, the **ABC classification** method is widely used to categorize items, customers, or any group members according to their relative contribution to a total metric.  
 
-In business and financial analytics, the **ABC classification** method is widely used to categorize items, customers, or other groups according to their relative contribution to a total metric.  
-The `abc()` function provides an easy way to classify a group's member by their relative contribution of either their **transaction counts** or the sum of a **numeric variable** such as sales margin or revenue.
+The `abc()` function applies this method by ranking group members according to either transaction counts or the sum of a numeric variable (e.g., revenue, margin):
 
 - Allows for **custom break points** (e.g., top 10% = A, next 40% = B, etc.)
 - Works on both **tibbles** and **database objects**
@@ -56,6 +54,13 @@ tibble::tibble(
 ```
 
 
+When you execute `abc()`, your console will return a `segment_abc` object displaying a custom print message:
+
+-  A summary of the function's actions
+-  Details the category break points and labels
+-  Describes the main transformation steps and columns that are referenced
+-  Lists out possible next actions
+
 
 ```{r}
 #| label: abc-example
@@ -72,11 +77,7 @@ contoso::sales |>
       )
 ```
 
-The function returns a **segment object**
-
-- This will summarize the series of actions and meta information about your data
-- Use `calculate()` to generate the ABC classification table
-- This will return a duckdb DBI object use `dplyr::collect()` to return a tibble
+Use `calculate()` to generate the ABC classification table in a lazy DBI object. Use `dplyr::collect()` to return a tibble.
 
 ```{r}
 #| label: calculate
@@ -116,7 +117,7 @@ contoso::sales |>
    fpaR::calculate() |> 
    dplyr::collect() |> 
    dplyr::arrange(row_id) |> 
-   head(10) |> 
+   head(10) |>
    tinytable::tt()
 ```
 

vignettes/articles/calendar_types.qmd

@@ -14,12 +14,12 @@ quarto::write_yaml_metadata_block(
 
 ### Introduction
 
-In many fpaR functions, you will see a reference to a calendar_type argument which may confuse most of you, isn't there only one type of calendar?
+In many fpaR functions, you will see a reference to a `calendar_type` argument which may confuse most of you, isn't there only one type of calendar?
 
 To accomodate the uniqueness of some industries, financial planning analysis will often involve two calendar systems:
 
 1. **Standard Calendar**  
-2. **5-5-4 Calendar**  
+2. **Non-standard Calendar** such as `5-4-4`, `4-4-5` or `4-5-4`
 
 This vignette explains the differences between these calendars and their typical use cases.
 
@@ -29,7 +29,8 @@ This is your "typical" calendar also known as a conventional Gregorian calendar:
 
 - 12 months of varying lengths (28–31 days)
 - 52 weeks per year (sometimes 53 in leap years)
-- Months are uneven in length, which can cause challenges in period-over-period comparison
+- 7 days in a week 
+- 365 days in a year (except in the leap years)
 
 For most of your analysis this is most likely the calendar "type" that you need to follow
 **Example:**
@@ -49,25 +50,25 @@ The primary disadvantage of this calendar is that when you try to compare a metr
 This can lead to misleading conclusions that revenue is increasing or decreasing
 
 
-### 5-5-4 Calendar
+### 5-4-4 Calendar
 
-The **5-5-4 calendar** is commonly used in retail designed to simplify period-over-period comparisons which a standard calendar introduces
+The **5-4-4 calendar** is commonly used in retail designed to simplify period-over-period comparisons which a standard calendar introduces
 
-- Each quarter has **13 weeks**, divided into three periods: 5 weeks, 5 weeks, 4 weeks
+- Each quarter has **13 weeks**, divided into three periods: 5 weeks, 4 weeks, 4 weeks
 - Each month in the quarter has a fixed number of weeks (rather than days)
 - Some years include a **53rd week** to align with the solar calendar
 
-**Example of a Quarter in 5-5-4 Calendar:**
+**Example of a Quarter in 5-4-4 Calendar:**
 
 | Period | Weeks |
 |--------|------|
 | Month 1 | 5 |
-| Month 2 | 5 |
+| Month 2 | 4 |
 | Month 3 | 4 |
 
 ### Comparison
 
-| Feature | Standard Calendar | 5-5-4 Calendar |
+| Feature | Standard Calendar | 5-4-4 Calendar |
 |---------|-----------------|----------------|
 | Basis | Days in month | Weeks in period |
 | Month Length | Varies (28–31 days) | Fixed (4 or 5 weeks) |
@@ -77,7 +78,7 @@ The **5-5-4 calendar** is commonly used in retail designed to simplify period-ov
 
 ### How to reference in `fpaR` functions?
 
-Where you see `calandar_type` argument in function you can either put in "standard" to get a traditional calendar or you can put "554" or  "445" to get the alternative cealndar equivalents.
+Where you see `calandar_type` argument in function you can either put in "standard" to get a traditional calendar or you can put "544","454" or  "445" to get the alternative calendar equivalents.
 
 Under the hood `fpaR` will create and convert your calendar to right calendar types an the functions will correctly index of the new keys.