浏览代码

update man

genderequality-alternative
flavis 4 年前
父节点
当前提交
12452df224
共有 4 个文件被更改,包括 9 次插入9 次删除
  1. +1
    -1
      man/join_speaker.Rd
  2. +4
    -2
      man/read_all.Rd
  3. +3
    -3
      man/repair.Rd
  4. +1
    -3
      man/word_usage_by_date.Rd

+ 1
- 1
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


+ 4
- 2
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


+ 3
- 3
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.}


+ 1
- 3
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{


正在加载...
取消
保存