From 12452df22448c70a697d3ea2ef365a66f9a9e712 Mon Sep 17 00:00:00 2001
From: flavis <christian@flavigny.de>
Date: Tue, 10 Aug 2021 17:05:19 +0200
Subject: [PATCH] update man

---
 man/join_speaker.Rd       | 2 +-
 man/read_all.Rd           | 6 ++++--
 man/repair.Rd             | 6 +++---
 man/word_usage_by_date.Rd | 4 +---
 4 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/man/join_speaker.Rd b/man/join_speaker.Rd
index 5b6413b..9e4c078 100644
--- a/man/join_speaker.Rd
+++ b/man/join_speaker.Rd
@@ -14,7 +14,7 @@ join_speaker(tb, res, fraction_only = F)
 \item{fraction_only}{if TRUE, only select fraction from the resulting joined tibble
 
 left join speaker information from res$speaker into tb.
-if fraction_only}
+if fraction_only, drop all columns but fraction}
 }
 \description{
 add information from speaker table to a tibble containing speaker id
diff --git a/man/read_all.Rd b/man/read_all.Rd
index 9e7874b..f3c5ebf 100644
--- a/man/read_all.Rd
+++ b/man/read_all.Rd
@@ -4,10 +4,12 @@
 \alias{read_all}
 \title{Parse xml records}
 \usage{
-read_all(path = "inst/records/")
+read_all(path = "inst/records/", pattern = "-data\\\\.xml")
 }
 \arguments{
-\item{path}{character}
+\item{path}{path to records directory}
+
+\item{pattern}{search pattern to find records in directory}
 }
 \description{
 Creates a list of tibbles containing relevant information from all records
diff --git a/man/repair.Rd b/man/repair.Rd
index 8a57937..a6772c7 100644
--- a/man/repair.Rd
+++ b/man/repair.Rd
@@ -4,14 +4,14 @@
 \alias{repair}
 \title{Repair parsed tables}
 \usage{
-repair(parse_output, repair_comments = FALSE)
+repair(parse_output, lookup_speaker = FALSE)
 }
 \arguments{
 \item{parse_output}{tibble}
 
-\item{repair_comments}{bool
+\item{lookup_speaker}{bool
 
-If repair_comments is TRUE, members of the parliament mentioned in comments are looked up in speaker table.
+If lookup_speaker is TRUE, members of the parliament mentioned in comments are looked up in speaker table.
 
 Possible test: check identical(repair(res), repair(repair(res))) == TRUE
 Since repaired tables should be a fixpoint of repair.}
diff --git a/man/word_usage_by_date.Rd b/man/word_usage_by_date.Rd
index 661d9c5..82919ca 100644
--- a/man/word_usage_by_date.Rd
+++ b/man/word_usage_by_date.Rd
@@ -4,15 +4,13 @@
 \alias{word_usage_by_date}
 \title{Word usage summarised by date}
 \usage{
-word_usage_by_date(res, patterns, name, tidy = F)
+word_usage_by_date(res, patterns, tidy = F)
 }
 \arguments{
 \item{res}{List of Tibbles to be analysed.}
 
 \item{patterns}{Words to look up.}
 
-\item{name}{?}
-
 \item{tidy}{default is FALSE.}
 }
 \description{