update man

This commit is contained in:
2021-08-10 17:05:19 +02:00
parent 77f79f0d86
commit 12452df224
4 changed files with 9 additions and 9 deletions
+1 -1
View File
@@ -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
+4 -2
View File
@@ -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
+3 -3
View File
@@ -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.}
+1 -3
View File
@@ -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{