From 0dfdcd557a228a267270fa0d8c05700ca8523059 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Todor=20Kondi=C4=87?= <todor.kondic@uni.lu>
Date: Mon, 12 Oct 2020 14:23:39 +0200
Subject: [PATCH] Update docs and NAMESPACE

---
 NAMESPACE             |  1 +
 man/sort_spectra.Rd   | 25 +++++++++++++++++++++++++
 man/subset_summary.Rd | 23 +++++++++++++++++++++++
 3 files changed, 49 insertions(+)
 create mode 100644 man/sort_spectra.Rd
 create mode 100644 man/subset_summary.Rd

diff --git a/NAMESPACE b/NAMESPACE
index c0670bb..43fb427 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -14,5 +14,6 @@ export(prescreen)
 export(run)
 export(run_in_dir)
 export(sort_spectra)
+export(subset_summary)
 import(data.table)
 importFrom(shiny,validate)
diff --git a/man/sort_spectra.Rd b/man/sort_spectra.Rd
new file mode 100644
index 0000000..49954c4
--- /dev/null
+++ b/man/sort_spectra.Rd
@@ -0,0 +1,25 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/api.R
+\name{sort_spectra}
+\alias{sort_spectra}
+\title{Sort the Summary Table}
+\usage{
+sort_spectra(m)
+}
+\arguments{
+\item{m}{}
+}
+\value{
+m
+}
+\description{
+Sets the key specified by DEF_KEY_SUMM and adds second indices,
+either from DEF_INDEX_SUMM, or user-specified in
+conf[\link{"summary table"}]$order. The order entry is a list of
+strings with names of columns in summ, optionally prefixed with a
+minus(-) sign. Columns prefixed with the minus are going to be in
+ascending order.
+}
+\author{
+Todor Kondić
+}
diff --git a/man/subset_summary.Rd b/man/subset_summary.Rd
new file mode 100644
index 0000000..45deb6e
--- /dev/null
+++ b/man/subset_summary.Rd
@@ -0,0 +1,23 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/api.R
+\name{subset_summary}
+\alias{subset_summary}
+\title{Subset the Summary Table}
+\usage{
+subset_summary(m)
+}
+\arguments{
+\item{m}{}
+}
+\value{
+m
+}
+\description{
+Subsets the summary table by applying conditions set out in the
+filter subkey of summary table key of the config. Each member of
+filter is an expression that and all of them are chained together
+using AND logical operation and applied to the summary table.
+}
+\author{
+Todor Kondić
+}
-- 
GitLab