add documentations

2021-08-06 19:07:35 +02:00
parent 1433159e09
commit d5da636020
7 changed files with 135 additions and 4 deletions
@@ -0,0 +1,46 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/analyze.R
+\name{bar_plot_fractions}
+\alias{bar_plot_fractions}
+\title{Bar chart of the fractions}
+\usage{
+bar_plot_fractions(
+  tb,
+  x_variable = NULL,
+  y_variable = NULL,
+  fill = NULL,
+  title = NULL,
+  xlab = "Fraction",
+  ylab = "n",
+  filllab = "Fraction",
+  flipped = TRUE,
+  position = "dodge",
+  reorder = FALSE
+)
+}
+\arguments{
+\item{tb}{The tibble to be analyzed.}
+
+\item{x_variable}{Default is fraction.}
+
+\item{y_variable}{Default is n.}
+
+\item{fill}{Default is fraction.}
+
+\item{title}{Title of the chart.}
+
+\item{xlab}{Description of x-Lab. Default is Fraction.}
+
+\item{ylab}{Description of y-Lab. Default is n.}
+
+\item{filllab}{Default is Fraction.}
+
+\item{flipped}{Default is TRUE. If TRUE draw bars horizontally, else vertically.}
+
+\item{position}{Default is dodge.}
+
+\item{reorder}{Either reorder fraction factor by variable value or reorder fraction factor by party seat order in parliament (default).}
+}
+\description{
+Bar chart of the fractions
+}
@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/analyze.R
+\name{join_speaker}
+\alias{join_speaker}
+\title{Assign speaker-name to speaker-ID}
+\usage{
+join_speaker(tb, res, fraction_only = F)
+}
+\arguments{
+\item{tb}{tibble}
+
+\item{res}{list of tibbles}
+
+\item{fraction_only}{If TRUE select only from "fraction"}
+}
+\description{
+Assign speaker-name to speaker-ID.
+}
@@ -0,0 +1,16 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/analyze.R
+\docType{data}
+\name{party_colors}
+\alias{party_colors}
+\title{Assignment of the official colors to the parties}
+\format{
+An object of class \code{character} of length 8.
+}
+\usage{
+party_colors
+}
+\description{
+Assignment of the official colors to the parties
+}
+\keyword{datasets}
@@ -0,0 +1,20 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/analyze.R
+\name{word_usage_by_date}
+\alias{word_usage_by_date}
+\title{Word usage summarised by date}
+\usage{
+word_usage_by_date(res, patterns, name, 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{
+Counts how many talks do match a given pattern and summarises by date.
+}