From 13209403b8e9e35ff6b99d70d8befe9ed6026aea Mon Sep 17 00:00:00 2001
From: egouldo <egouldo@users.noreply.github.com>
Date: Wed, 14 Aug 2024 17:28:24 +1000
Subject: [PATCH] #97 #102 rebuild documentation

---
 NAMESPACE                                     |  2 ++
 man/back_transform_response_vars_yi.Rd        |  2 +-
 ...se_response.Rd => process_analyst_data.Rd} | 33 ++++++++++++++-----
 3 files changed, 28 insertions(+), 9 deletions(-)
 rename man/{standardise_response.Rd => process_analyst_data.Rd} (50%)

diff --git a/NAMESPACE b/NAMESPACE
index 2d98d80..b7bc607 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -140,10 +140,12 @@ importFrom(magrittr,"%>%")
 importFrom(metaviz,viz_funnel)
 importFrom(parameters,parameters)
 importFrom(performance,performance)
+importFrom(pointblank,col_exists)
 importFrom(pointblank,col_vals_not_null)
 importFrom(pointblank,has_columns)
 importFrom(pointblank,stop_if_not)
 importFrom(pointblank,test_col_vals_gte)
+importFrom(pointblank,vars)
 importFrom(purrr,keep)
 importFrom(purrr,list_flatten)
 importFrom(purrr,list_rbind)
diff --git a/man/back_transform_response_vars_yi.Rd b/man/back_transform_response_vars_yi.Rd
index a7b3664..3480f20 100644
--- a/man/back_transform_response_vars_yi.Rd
+++ b/man/back_transform_response_vars_yi.Rd
@@ -25,6 +25,6 @@ Back Transform Response Variables - yi
 }
 \seealso{
 Other analyst-data: 
-\code{\link{standardise_response}()}
+\code{\link{process_analyst_data}}
 }
 \concept{analyst-data}
diff --git a/man/standardise_response.Rd b/man/process_analyst_data.Rd
similarity index 50%
rename from man/standardise_response.Rd
rename to man/process_analyst_data.Rd
index 184b73d..9a9b050 100644
--- a/man/standardise_response.Rd
+++ b/man/process_analyst_data.Rd
@@ -1,8 +1,10 @@
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/standardise_response.R
-\name{standardise_response}
+\name{process_analyst_data}
+\alias{process_analyst_data}
 \alias{standardise_response}
-\title{Standardise Response Variable}
+\alias{process_response}
+\title{Process Response Data for Meta-Analysis}
 \usage{
 standardise_response(
   dat,
@@ -10,6 +12,8 @@ standardise_response(
   param_table = NULL,
   dataset = character(1L)
 )
+
+process_response(dat, estimate_type = NULL, param_table = NULL, dataset = NULL)
 }
 \arguments{
 \item{dat}{A tibble of analyst data with a list-column called}
@@ -24,22 +28,35 @@ standardise_response(
 A tibble of analyst data with standardised values contained in a list-column called 'back_transformed_data'
 }
 \description{
-Standardise Response Variable
+This function generates the response data for meta-analysis without standardising the effect sizes / out-of-sample predictions.
 }
 \details{
-When the \code{estimate_type} is \code{"Zr"}, \code{\link[=standardise_response]{standardise_response()}} standardises effect-sizes with \code{\link[=est_to_zr]{est_to_zr()}}, assuming that the \code{beta_estimate} and \code{beta_SE} values have already been back-transformed to the appropriate scale. #TODO check this.
+When the \code{estimate_type} is \code{"Zr"}, \code{\link[=standardise_response]{standardise_response()}} standardises
+effect-sizes with \code{\link[=est_to_zr]{est_to_zr()}}, assuming that the \code{beta_estimate} and
+\code{beta_SE} values have already been back-transformed to the appropriate scale. #TODO check this.
 
 When the \code{estimate-type} is \code{"yi"} or otherwise, the function:
 \enumerate{
-\item assigns a \code{transformation_type} with \code{\link[=assign_transformation_type]{assign_transformation_type()}}, assumes that
-\item Converts the out-of-sample predictions on the link- or transformed-response scale back to the original response scale using \code{\link[=convert_predictions]{convert_predictions()}}.
+\item assigns a \code{transformation_type} with \code{\link[=assign_transformation_type]{assign_transformation_type()}},
+assumes that
+\item Converts the out-of-sample predictions on the link- or transformed-response
+scale back to the original response scale using \code{\link[=convert_predictions]{convert_predictions()}}.
 \item Standardises predictions on the original response-scale to the Z-scale, with \code{\link[=pred_to_Z]{pred_to_Z()}}.
 }
 
-Note that for $y_i$ or out of sample predictions that are standardised, if param_table is \code{NA} or \code{NULL} for a given variable, then the response variable will not be standardised, and NA will be returned for that entry in \code{back_transformed_data}.
+Note that for $y_i$ or out of sample predictions that are standardised,
+if param_table is \code{NA} or \code{NULL} for a given variable, then the response
+variable will not be standardised, and NA will be returned for that entry in \code{back_transformed_data}.
 }
+\section{Functions}{
+\itemize{
+\item \code{standardise_response()}: Standardise response data for meta-analysis
+
+\item \code{process_response()}: Process response data for meta-analysis but do not standardise effect-sizes
+
+}}
 \seealso{
-\code{\link[=est_to_zr(), assign_transformation_type]{est_to_zr(), assign_transformation_type()}}
+\code{\link[=est_to_zr]{est_to_zr()}},  \code{\link[=assign_transformation_type]{assign_transformation_type()}}
 
 Other analyst-data: 
 \code{\link{back_transform_response_vars_yi}()}