docs: CRAN Rd changes

- Remove Rd files for internal functions where they are unnecessary
- Add \value where missing

R/check_query.R

@@ -76,6 +76,7 @@ check_query <- function(data, return = "message", validation = FALSE){
 #'
 #' @details Used as part of `check_query()`.
 #'
+#' @noRd
 #'
 check_person_query <- function(data, return){
 
@@ -174,6 +175,7 @@ check_person_query <- function(data, return){
 #'
 #' @details Used as part of `check_query()`.
 #'
+#' @noRd
 check_query_validation <- function(data, return){
   ## Query Type - Initialise
   main_chunk <- ""

R/dv_data.R

@@ -10,6 +10,8 @@
 #'
 #' @family Data
 #'
+#' @return data frame.
+#'
 #' @format A data frame with 897 rows and 69 variables:
 #' \describe{
 #'   \item{PersonId}{ }

R/em_data.R

@@ -12,6 +12,8 @@
 #'
 #' @family Data
 #'
+#' @return data frame.
+#'
 #' @format A data frame with 41567 rows and 56 variables:
 #' \describe{
 #'   \item{PersonId}{ }

R/g2g_data.R

@@ -11,6 +11,8 @@
 #' @family Data
 #' @family Network
 #'
+#' @return data frame.
+#'
 #' @format A data frame with 3517 rows and 7 variables:
 #' \describe{
 #'   \item{TimeInvestors_Organization}{ }

R/generate_report.R

@@ -158,6 +158,8 @@ generate_report <- function(title = "My minimal HTML generator",
 #' @param subheader Character string to specify the subheader of the chunk.
 #' @param echo Logical value to specify whether to display code.
 #' @param object Character string to specify name of the object to show.
+#'
+#' @noRd
 generate_chunks <- function(level = 3,
                             title,
                             subheader = "",
@@ -219,6 +221,8 @@ read_preamble <- function(path){
 #'
 #' @family Support
 #'
+#' @noRd
+#'
 md2html <- function(text){
 
   html_chunk <- markdown::markdownToHTML(text = text,

R/init.R

@@ -4,7 +4,7 @@
 # --------------------------------------------------------------------------------------------
 
 .onAttach <- function(libname, pkgname) {
-  message <- c("\n Thank you for using v1.4.2 of the {wpa} R package !",
+  message <- c("\n Thank you for using v1.4.3 of the {wpa} R package!",
                "\n \n Our analysts have taken every care to ensure that this package runs smoothly and bug-free.",
                "\n \n However, if you do happen to encounter any, please report any issues at",
                "\n https://github.com/microsoft/wpa/issues/",

R/mt_data.R

@@ -10,6 +10,8 @@
 #'
 #' @family Data
 #'
+#' @return data frame.
+#'
 #' @format A data frame with 2001 rows and 30 variables:
 #' \describe{
 #'   \item{MeetingId}{ }

R/p2p_data_sim.R

@@ -59,6 +59,8 @@ p2p_data_sim <- function(dim = 1,
 #'   - `Organization`
 #'   - `LevelDesignation`
 #'   - `City`
+#'
+#' @noRd
 add_cat <- function(x, type){
 
   if(type == "Organization"){

R/sq_data.R

@@ -10,6 +10,8 @@
 #'
 #' @family Data
 #'
+#' @return data frame.
+#'
 #' @format A data frame with 13442 rows and 66 variables:
 #' \describe{
 #'   \item{PersonId}{ }

R/supporting_functions.R

@@ -201,6 +201,8 @@ comma <- function(x){
 #' @param pkgname String containing the name of the package to check whether is
 #' installed.
 #'
+#' @noRd
+#'
 check_pkg_installed <- function(pkgname) {
 
   mtry <- try(find.package(package = pkgname))

R/workpatterns_classify_bw.R

@@ -43,6 +43,17 @@
 #' @param end_hour A character vector specifying finish hours,
 #' e.g. "1700"
 #'
+#' @return
+#' A different output is returned depending on the value passed to the `return`
+#' argument:
+#'   - `"plot"`: returns a heatmap plot of signal distribution by hour
+#'   and archetypes (default). A 'ggplot' object.
+#'   - `"data"`: returns a data frame of the raw data with the classified
+#'   archetypes
+#'   - `"table"`: returns a data frame of summary table of the archetypes
+#'   - `"plot-area"`: returns an area plot of the percentages of archetypes
+#'   shown over time. A 'ggplot' object.
+#'
 #' @import ggplot2
 #' @importFrom magrittr "%>%"
 #' @importFrom data.table ":=" "%like%" "%between%"

R/workpatterns_classify_pav.R

@@ -15,10 +15,10 @@
 #' @param data A data frame containing data from the Hourly Collaboration query.
 #'
 #' @param return Character vector to specify what to return. Valid options include:
-#'   - "plot": returns a bar plot of signal distribution by hour and archetypes (default)
-#'   - "data": returns the raw data with the classified archetypes
-#'   - "table": returns a summary table of the archetypes
-#'   - "plot-area": returns an overlapping area plot
+#'   - `"plot"`: returns a bar plot of signal distribution by hour and archetypes (default)
+#'   - `"data"`: returns the raw data with the classified archetypes
+#'   - `"table"`: returns a summary table of the archetypes
+#'   - `"plot-area"`: returns an overlapping area plot
 #'
 #' @param values Character vector to specify whether to return percentages
 #' or absolute values in "data" and "plot". Valid values are:
@@ -37,6 +37,15 @@
 #' @param end_hour A character vector specifying starting hours,
 #' e.g. "1700"
 #'
+#' @return
+#' A different output is returned depending on the value passed to the `return`
+#' argument:
+#'   - `"plot"`: returns a bar plot of signal distribution by hour and
+#'   archetypes (default). A 'ggplot' object.
+#'   - `"data"`: returns a data frame of the raw data with the classified archetypes.
+#'   - `"table"`: returns a data frame of a summary table of the archetypes.
+#'   - `"plot-area"`: returns an overlapping area plot. A 'ggplot' object.
+#'
 #' @import dplyr
 #' @import tidyselect
 #' @import ggplot2

R/workpatterns_hclust.R

@@ -255,6 +255,7 @@ workpatterns_hclust <- function(data,
 #' @importFrom tidyselect all_of
 #' @importFrom tidyr gather
 #'
+#' @noRd
 plot_signal_clust <- function(data,
                               group_label,
                               type = "bar",
@@ -368,6 +369,7 @@ plot_signal_clust <- function(data,
 #' or the groups. Currently accepted values are "cluster" and "Personas".
 #' @param sig_label See `workpatterns_hclust()`.
 #'
+#' @noRd
 run_sum_hr <- function(data,
                        group_label = "cluster",
                        sig_label = "Emails_sent"){
@@ -423,7 +425,7 @@ run_sum_hr <- function(data,
 #' @param end_hour See `workpatterns_hclust()`.
 #' @param group_label See `workpatterns_hclust()`.
 #'
-#'
+#' @noRd
 run_hour_splits <- function(data,
                             start_hour = "0900",
                             end_hour = "1700",

man/add_cat.Rd

@@ -1,21 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/p2p_data_sim.R
-\name{add_cat}
-\alias{add_cat}
-\title{Add organizational data to the simulated p2p data}
-\usage{
-add_cat(x, type)
-}
-\arguments{
-\item{x}{Numeric vector to be assigned simulated organizational attributes}
-
-\item{type}{String with three valid options:
-\itemize{
-\item \code{Organization}
-\item \code{LevelDesignation}
-\item \code{City}
-}}
-}
-\description{
-Add organizational data to the simulated p2p data
-}

man/camel_clean.Rd

@@ -32,7 +32,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/check_inputs.Rd

@@ -48,7 +48,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/check_person_query.Rd

@@ -1,34 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/check_query.R
-\name{check_person_query}
-\alias{check_person_query}
-\title{Check a Person Query to ensure that it is suitable for analysis}
-\usage{
-check_person_query(data, return)
-}
-\arguments{
-\item{data}{A person-level query in the form of a data frame. This includes:
-\itemize{
-\item Standard Person Query
-\item Ways of Working Assessment Query
-\item Hourly Collaboration Query
-}
-
-All person-level query have a \code{PersonId} column and a \code{Date} column.}
-
-\item{return}{String specifying what to return. This must be one of the
-following strings:
-\itemize{
-\item \code{"message"} (default)
-\item \code{"text"}
-}
-
-See \code{Value} for more information.}
-}
-\description{
-Prints diagnostic data about the data query to the R console, with information
-such as date range, number of employees, HR attributes identified, etc.
-}
-\details{
-Used as part of \code{check_query()}.
-}

man/check_pkg_installed.Rd

@@ -1,17 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/supporting_functions.R
-\name{check_pkg_installed}
-\alias{check_pkg_installed}
-\title{Check whether package is installed and return an error message}
-\usage{
-check_pkg_installed(pkgname)
-}
-\arguments{
-\item{pkgname}{String containing the name of the package to check whether is
-installed.}
-}
-\description{
-Checks whether a package is installed in the user's machine
-based on a search on the package name string. If the package is not
-installed, an error message is returned.
-}

man/check_query_validation.Rd

@@ -1,35 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/check_query.R
-\name{check_query_validation}
-\alias{check_query_validation}
-\title{Perform a query check for the validation report}
-\usage{
-check_query_validation(data, return)
-}
-\arguments{
-\item{data}{A person-level query in the form of a data frame. This includes:
-\itemize{
-\item Standard Person Query
-\item Ways of Working Assessment Query
-\item Hourly Collaboration Query
-}
-
-All person-level query have a \code{PersonId} column and a \code{Date} column.}
-
-\item{return}{String specifying what to return. This must be one of the
-following strings:
-\itemize{
-\item \code{"message"} (default)
-\item \code{"text"}
-}
-
-See \code{Value} for more information.}
-}
-\description{
-Prints diagnostic data about the data query to the R console, with information
-such as date range, number of employees, HR attributes identified, etc.
-Optimised for the \code{validation_report()}
-}
-\details{
-Used as part of \code{check_query()}.
-}

man/combine_signals.Rd

@@ -47,7 +47,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/cut_hour.Rd

@@ -44,7 +44,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/dv_data.Rd

@@ -86,6 +86,9 @@ A data frame with 897 rows and 69 variables:
 \usage{
 dv_data
 }
+\value{
+data frame.
+}
 \description{
 A dataset generated from a Standard Person Query from Workplace Analytics.
 }

man/em_data.Rd

@@ -73,6 +73,9 @@ A data frame with 41567 rows and 56 variables:
 \usage{
 em_data
 }
+\value{
+data frame.
+}
 \description{
 A sample dataset generated from an Hourly Collaboration query from the
 Workplace Analytics demo tenant. The data is grouped by week and contains

man/extract_date_range.Rd

@@ -40,7 +40,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/extract_hr.Rd

@@ -55,7 +55,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/g2g_data.Rd

@@ -24,6 +24,9 @@ A data frame with 3517 rows and 7 variables:
 \usage{
 g2g_data
 }
+\value{
+data frame.
+}
 \description{
 A demo dataset generated from a Group-to-Group Query from Workplace Analytics.
 }

man/generate_chunks.Rd

@@ -1,30 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/generate_report.R
-\name{generate_chunks}
-\alias{generate_chunks}
-\title{Generate chunk strings}
-\usage{
-generate_chunks(level = 3, title, subheader = "", echo = FALSE, object)
-}
-\arguments{
-\item{level}{Numeric value to specify the header level of the chunk.}
-
-\item{title}{Character string to specify the title of the chunk.}
-
-\item{subheader}{Character string to specify the subheader of the chunk.}
-
-\item{echo}{Logical value to specify whether to display code.}
-
-\item{object}{Character string to specify name of the object to show.}
-}
-\description{
-This is used as a supporting function for \code{generate_report()}
-and not directly used. `generate_report()`` works by creating a
-loop structure around generate_chunks(), and binds them together
-to create a report.
-}
-\details{
-\code{generate_chunks()} is primarily a wrapper around paste() functions,
-to create a structured character vector that will form the individual
-chunks. No plots 'exist' within the environment of \code{generate_chunks()}.
-}

man/heat_colours.Rd

@@ -43,7 +43,6 @@ Other Support:
 \code{\link{extract_hr}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/is_date_format.Rd

@@ -31,7 +31,6 @@ Other Support:
 \code{\link{extract_hr}()},
 \code{\link{heat_colours}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/maxmin.Rd

@@ -37,7 +37,6 @@ Other Support:
 \code{\link{extract_hr}()},
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/md2html.Rd

@@ -1,41 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/generate_report.R
-\name{md2html}
-\alias{md2html}
-\title{Display HTML fragment in RMarkdown chunk, from Markdown text}
-\usage{
-md2html(text)
-}
-\arguments{
-\item{text}{Character vector containing Markdown text}
-}
-\description{
-This is a wrapper around \code{markdown::markdownToHTML()}, where
-the default behaviour is to produce a HTML fragment.
-\code{htmltools::HTML()} is then used to evaluate the HTML code
-within a RMarkdown chunk.
-}
-\seealso{
-Other Support: 
-\code{\link{camel_clean}()},
-\code{\link{check_inputs}()},
-\code{\link{combine_signals}()},
-\code{\link{cut_hour}()},
-\code{\link{extract_date_range}()},
-\code{\link{extract_hr}()},
-\code{\link{heat_colours}()},
-\code{\link{is_date_format}()},
-\code{\link{maxmin}()},
-\code{\link{p_test}()},
-\code{\link{pairwise_count}()},
-\code{\link{plot_WOE}()},
-\code{\link{read_preamble}()},
-\code{\link{rgb2hex}()},
-\code{\link{totals_bind}()},
-\code{\link{totals_col}()},
-\code{\link{totals_reorder}()},
-\code{\link{tstamp}()},
-\code{\link{us_to_space}()},
-\code{\link{wrap}()}
-}
-\concept{Support}

man/mt_data.Rd

@@ -54,6 +54,9 @@ A data frame with 2001 rows and 30 variables:
 \usage{
 mt_data
 }
+\value{
+data frame.
+}
 \description{
 A dataset generated from a Meeting Query from Workplace Analytics.
 }

man/p_test.Rd

@@ -49,7 +49,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},
 \code{\link{read_preamble}()},

man/pairwise_count.Rd

@@ -44,7 +44,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{plot_WOE}()},
 \code{\link{read_preamble}()},

man/plot_WOE.Rd

@@ -30,7 +30,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{read_preamble}()},

man/plot_signal_clust.Rd

@@ -1,25 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/workpatterns_hclust.R
-\name{plot_signal_clust}
-\alias{plot_signal_clust}
-\title{Plot signal hour patterns by clusters}
-\usage{
-plot_signal_clust(data, group_label, type = "bar", sig_label = "Emails_sent")
-}
-\arguments{
-\item{data}{Data frame containing the normalised email by hour
-data and the cluster variable}
-
-\item{group_label}{Character vector specifying the name of the variable
-containing the clusters.}
-
-\item{type}{Character vector to specify type of plot to return.
-Accepted values are "bar" (default) and "area".}
-
-\item{sig_label}{Character vector to select required columns,
-e.g. "Emails_sent", "IMs_sent", "Signals_sent"}
-}
-\description{
-Workhorse function feeding into \code{workpatterns_hclust()}.
-This is a build on \code{plot_email_clust} to allow flexible inputs.
-}

man/read_preamble.Rd

@@ -27,7 +27,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/rgb2hex.Rd

@@ -26,7 +26,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/run_hour_splits.Rd

@@ -1,25 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/workpatterns_hclust.R
-\name{run_hour_splits}
-\alias{run_hour_splits}
-\title{Run working hour splits for signals sent}
-\usage{
-run_hour_splits(
-  data,
-  start_hour = "0900",
-  end_hour = "1700",
-  group_label = "cluster"
-)
-}
-\arguments{
-\item{data}{See \code{workpatterns_hclust()}.}
-
-\item{start_hour}{See \code{workpatterns_hclust()}.}
-
-\item{end_hour}{See \code{workpatterns_hclust()}.}
-
-\item{group_label}{See \code{workpatterns_hclust()}.}
-}
-\description{
-Used internally within \code{workpatterns_hclust()}
-}

man/run_sum_hr.Rd

@@ -1,20 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/workpatterns_hclust.R
-\name{run_sum_hr}
-\alias{run_sum_hr}
-\title{Run summary statistics for hours of day}
-\usage{
-run_sum_hr(data, group_label = "cluster", sig_label = "Emails_sent")
-}
-\arguments{
-\item{data}{See \code{workpatterns_hclust()}.}
-
-\item{group_label}{A character vector for the column name containing the clusters
-or the groups. Currently accepted values are "cluster" and "Personas".}
-
-\item{sig_label}{See \code{workpatterns_hclust()}.}
-}
-\description{
-Supporting function that takes the raw data from \code{workpatterns_hclust()}
-as an input.
-}

man/sq_data.Rd

@@ -84,6 +84,9 @@ the last email or meeting for each day of the work week.}
 \usage{
 sq_data
 }
+\value{
+data frame.
+}
 \description{
 A dataset generated from a Standard Person Query from Workplace Analytics.
 }

man/totals_bind.Rd

@@ -43,7 +43,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/totals_col.Rd

@@ -41,7 +41,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/totals_reorder.Rd

@@ -43,7 +43,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/tstamp.Rd

@@ -24,7 +24,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/us_to_space.Rd

@@ -30,7 +30,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},

man/workpatterns_classify_bw.Rd

@@ -52,6 +52,19 @@ archetypes
 shown over time
 }}
 }
+\value{
+A different output is returned depending on the value passed to the \code{return}
+argument:
+\itemize{
+\item \code{"plot"}: returns a heatmap plot of signal distribution by hour
+and archetypes (default). A 'ggplot' object.
+\item \code{"data"}: returns a data frame of the raw data with the classified
+archetypes
+\item \code{"table"}: returns a data frame of summary table of the archetypes
+\item \code{"plot-area"}: returns an area plot of the percentages of archetypes
+shown over time. A 'ggplot' object.
+}
+}
 \description{
 \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}
 

man/workpatterns_classify_pav.Rd

@@ -41,12 +41,23 @@ e.g. "1700"}
 
 \item{return}{Character vector to specify what to return. Valid options include:
 \itemize{
-\item "plot": returns a bar plot of signal distribution by hour and archetypes (default)
-\item "data": returns the raw data with the classified archetypes
-\item "table": returns a summary table of the archetypes
-\item "plot-area": returns an overlapping area plot
+\item \code{"plot"}: returns a bar plot of signal distribution by hour and archetypes (default)
+\item \code{"data"}: returns the raw data with the classified archetypes
+\item \code{"table"}: returns a summary table of the archetypes
+\item \code{"plot-area"}: returns an overlapping area plot
 }}
 }
+\value{
+A different output is returned depending on the value passed to the \code{return}
+argument:
+\itemize{
+\item \code{"plot"}: returns a bar plot of signal distribution by hour and
+archetypes (default). A 'ggplot' object.
+\item \code{"data"}: returns a data frame of the raw data with the classified archetypes.
+\item \code{"table"}: returns a data frame of a summary table of the archetypes.
+\item \code{"plot-area"}: returns an overlapping area plot. A 'ggplot' object.
+}
+}
 \description{
 \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}
 

man/wrap.Rd

@@ -29,7 +29,6 @@ Other Support:
 \code{\link{heat_colours}()},
 \code{\link{is_date_format}()},
 \code{\link{maxmin}()},
-\code{\link{md2html}()},
 \code{\link{p_test}()},
 \code{\link{pairwise_count}()},
 \code{\link{plot_WOE}()},