newCollection: Create or Extend a Collection

Description Usage Arguments Value Examples

View source: R/collections.R

Description

newCollection() can be used to create new collections or add dramas to existing collection files.

Usage

1
2
3
4
5
6
7
8
newCollection(
  drama,
  name = ifelse(inherits(drama, "QDDrama"), paste(unique(drama$meta$drama)),
    paste(drama, collapse = "_")),
  writeToFile = TRUE,
  dir = getOption("qd.collectionDirectory"),
  append = TRUE
)

Arguments

drama

A text (or multiple texts, as data.frame or data.table), or a character vector containing the drama IDs to be collected

name

The name of the collection and its filename (default = concatenated drama IDs)

writeToFile

= Whether to write the collection to a file (default = TRUE)

dir

The directory into which the collection file will be written (default = collection directory)

append

Whether to extend the collection file if it already exists. If FALSE, the file will be overwritten. (default = TRUE)

Value

The function returns the ids that belong to the collection as a character vector.

Examples

1
2
3
4
t <- combine(rksp.0, rjmw.0)
newCollection(t, writeToFile=FALSE)
newCollection(c("rksp.0", "rjmw.0"), writeToFile=FALSE) # produces identical file
newCollection(c("a", "b"), name="rksp.0_rjmw.0", writeToFile=FALSE) # adds "a" and "b" to the file

DramaAnalysis documentation built on Jan. 13, 2021, 10:02 p.m.