From b6ea6dc5e7f282672dbb41a6355e1fb2e1c44d44 Mon Sep 17 00:00:00 2001 From: Barbara Vreede Date: Fri, 2 Dec 2022 21:16:13 +0100 Subject: [PATCH] add documentation to treatment stats --- NAMESPACE | 1 + man/treatment_stats.Rd | 17 +++++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 man/treatment_stats.Rd diff --git a/NAMESPACE b/NAMESPACE index 20d5cfe..73d66fc 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -4,4 +4,5 @@ export(find_outliers) export(parse_MEA_file) export(parse_designfile) export(treatment_ratio) +export(treatment_stats) import(magrittr) diff --git a/man/treatment_stats.Rd b/man/treatment_stats.Rd new file mode 100644 index 0000000..a915608 --- /dev/null +++ b/man/treatment_stats.Rd @@ -0,0 +1,17 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/treatment_stats.R +\name{treatment_stats} +\alias{treatment_stats} +\title{Generate statistics for a treatment dataframe} +\usage{ +treatment_stats(ratio_df) +} +\arguments{ +\item{ratio_df}{resulting dataframe of the `treatment_ratio` function} +} +\value{ +dataframe with summary statistics +} +\description{ +Generate statistics for a treatment dataframe +}