Skip to contents

R6 Class representing a qualchemy project

R6 Class representing a qualchemy project

Details

A qualchemy project mostly just contains other objects.

Public fields

title

project title

metadata

The project's metadata in a list

codebook

A qualchemy codebook object

sources

A list of qualchemy source objects

description

description for the project

codings

A list of qualchemy coding objects (a coding is the application of a code to a part of a source)

users

A list of Qualchemy user objects

Methods


Method new()

Create a new Qualchemy project object

Usage

Qualchemy_project$new(
  title = "",
  description = "",
  metadata = list(),
  codebook = list(),
  sources = list(),
  codings = list(),
  users = list(),
  ...,
  error_call = quote(Qualchemy_project$new())
)

Arguments

title

project title

description

project description

metadata

A list with the project's metadata.

codebook

A Qualchemy_codebook object

sources

list of Qualchemy_source objects, one for each source

codings

list of Qualchemy_coding objects

users

users

...

additional arguments, for future extensions, currently unused

error_call

error context

Returns

A new Qualchemy_project object.


Method print()

print project

Usage

Qualchemy_project$print(...)

Arguments

...

currently ignored


Method write_rock()

write the project to a rock file

Usage

Qualchemy_project$write_rock(file)

Arguments

file

rock file


Method write_qdpx()

write to a qpdx file

Usage

Qualchemy_project$write_qdpx(file)

Arguments

file

output file


Method to_rock()

to rock format

Usage

Qualchemy_project$to_rock(codes = TRUE)

Arguments

codes

include the codes


Method to_rock_text()

the text in the rock format

Usage

Qualchemy_project$to_rock_text()


Method clone()

The objects of this class are cloneable with this method.

Usage

Qualchemy_project$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

projectExample <- Qualchemy_project$read_qdpx(example_qdpx())
projectExample
#> Qualchemy project "{qualchemy} Test Project".
#> • codebook with 4 codes.
#> • 25 codings.
#> • 1 text source.