DataPackage-class: Class '"DataPackage"'
In JasonHackney/ReportingTools: Tools for making reports in various formats

DataPackage-class

R Documentation

Class `"DataPackage"`

Description

This is a pointer to an R data package. The result should be an installable R data package, with documentation for the data objects published therein.

Objects from the Class

Objects can be created by calls of the form new("DataPackage", ...).

Slots

version:: The current version of the generated data package
dependencies:: A character vector of packages that the data package depends on.
author:: The author(s) of the data package.
maintainer:: The maintainer(s) of the data package. Defaults to the same person as the author.
license:: What license to use when creating the data package.
description:: The description of the data package.
package.Rd:: Rd string for package-level help for the generated data package.
shortName:: Name of the data package.
title:: The title of the package
reportDirectory:: The directory in which the data package is generated.

Extends

Class "BaseReport", directly.

Methods

dependencies: Retrieve the list of dependencies for the data package.
dependencies<-: Set the list of dependencies for the data package.
finish: This is the final step in publishing objects to the data pacakge. It recreates the DESCRIPTION file for the data package. The package name, title, version, author, maintainer, dependencies, license and description are set from the appropriate slots in the DataPackage object.

Examples

my.df <- data.frame(EGID = c("103", "104", "105", "106", "107"),
                    RPKM = c(4, 5, 3, 100, 75),
                    DE = c("Yes", "Yes", "No", "No", "No"))
data.package <- DataPackage('MyPackage', title = "My awesome package",
    author = "J.J. Nobody", maintainer = "J.J. Nobody <nobody@nowhere.net>")
publish('my.df', data.package)

dependencies(data.package) # Returns "Biobase"
dependencies(data.package) <- c('Biobase','GSEABase')

finish(data.package)

JasonHackney/ReportingTools documentation built on Oct. 23, 2023, 9:24 p.m.