DcfRefClass-class: Reference class for DESCRIPTION information

In pvrqualitasag/rqudocuhelper:

Description

DcfRefClass reference objects can be used to represent dcf structured information that is usually stored in DESCRIPTION files of a package. The basic functionality of DcfRefClass reference objects consists of

• reading a dcf files

• changing dcf components

• writing a dcf structure back to a file

Details

When creating a new package with devtools::create() the default description file contains the field Author@R which contains the definition of a person() object as a string. This field is difficult to change, hence this field Author@R is converted into a simple field Author of type string and in a field Maintainer which is also of type string. This conversion is done immediately when the DESCRIPTION file is read.

Fields

lCurDesc

current dcf read from DESCRIPTION as a list

Methods

getAuthor()

getter for author

getDescription()

getter for description

getLicence()

getter for license

getMaintainer()

getter for maintainer

getTitle()

getter for title

readDcf(psDcfFile = "DESCRIPTION")

Read a description file using read.dcf. Convert resulting dataframe to a list using columnnames of dataframe as names for list, except for the field Author@R. See Details for more information

setAuthor(psAuthor)

setter for author

setDescription(psDescription)

setter for description

setLicense(psLicense)

setter for license

setMaintainer(psMaintainer)

setter for maintainer

setTitle(psTitle)

setter for title

writeDcf(psDcfFile = "DESCRIPTION")

Write a description file using write.dcf

pvrqualitasag/rqudocuhelper documentation built on May 26, 2019, 11:34 a.m.