diff --git a/man/make_split_fun.Rd b/man/make_split_fun.Rd index 0379fdacd..39be34bb2 100644 --- a/man/make_split_fun.Rd +++ b/man/make_split_fun.Rd @@ -42,29 +42,13 @@ because they will not be present when validity checking is done). The preprocessing component is useful for things such as manipulating factor levels, e.g., to trim unobserved ones or to reorder levels based on observed counts, etc. -<<<<<<< HEAD -Core splitting functions override the fundamental -splitting procedure, and are only necessary in rare cases. These -must accept \code{spl}, \code{df}, \code{vals}, \code{labels}, and can optionally -accept \code{.spl_context}. They should return an split result object -constructed via \code{make_split_result()}. - -In particular, if the custom split function will be used in -column space, subsetting expressions (e.g., as returned by -\code{quote()} or \code{bquote} must be provided, while they are -optional (and largely ignored, currently) in row space. -======= Customization of core splitting (2) is currently only supported in row splits. Core splitting functions override the fundamental splitting procedure, and are only necessary in rare cases. These must accept \code{spl}, \code{df}, \code{vals}, and -\code{labels}, and can optionally accept \code{.spl_context}. They must return a named list with elements, all of the same -length, as follows: -\itemize{ -\item \code{datasplit}, containing a list of \code{data.frame} objects. -\item \code{values}, containing values associated with the facets, which must be \code{character} or \code{SplitValue} objects. -These values will appear in the paths of the resulting table. -\item \code{labels}, containing the character labels associated with \code{values} -} ->>>>>>> main +\code{labels}, and can optionally accept \code{.spl_context}. They must return a split result object constructed via +\code{make_split_result()}. + +In particular, if the custom split function will be used in column space, subsetting expressions (e.g., as returned by +\code{quote()} or \code{bquote()} must be provided, while they are optional (and largely ignored, currently) in row space. Post-processing functions (3) must accept the result of the core split as their first argument (which can be anything), in addition to \code{spl}, and \code{fulldf}, and can optionally accept \code{.spl_context}. They must each return a diff --git a/man/make_split_result.Rd b/man/make_split_result.Rd index e1fbc8f6c..91b1f1a4b 100644 --- a/man/make_split_result.Rd +++ b/man/make_split_result.Rd @@ -32,14 +32,10 @@ add_to_split_result( \item{extras}{(\code{list} or \code{NULL})\cr extra values associated with each of the facets which will be passed to analysis functions applied within the facet.} -<<<<<<< HEAD -\item{subset_exprs}{list. A list of subsetting expressions (e.g., -created with \code{quote()}) to be used during column subsetting.} +\item{subset_exprs}{(\code{list})\cr a list of subsetting expressions (e.g., created with \code{quote()}) to be used +during column subsetting.} -\item{splres}{list. A list representing the result of splitting.} -======= \item{splres}{(\code{list})\cr a list representing the result of splitting.} ->>>>>>> main } \value{ A named list representing the facets generated by the split with elements \code{values}, \code{datasplit}, and @@ -54,12 +50,10 @@ These functions performs various housekeeping tasks to ensure that the split res internals expect it, most of which are not relevant to end users. } \note{ -Column splitting will not work correctly if a split function -calls \code{make_split_result} without specifying subset expressions; -row splitting will work as normal. This is due to the fact that -subsetting expressions are used during column splitting to -represent the data associated with facets, while actual data -subsets are used during row splitting. +Column splitting will not work correctly if a split function calls \code{make_split_result} without specifying +subset expressions; row splitting will work as normal. This is due to the fact that subsetting expressions are +used during column splitting to represent the data associated with facets, while actual data subsets are used +during row splitting. } \examples{ splres <- make_split_result(