featureset-classes: FeatureSet (and Sub)-Classes

In trackr: Semantic Annotation and Discoverability System for R-Based Artifacts

Description

Metadata inferred about R objects or dynamic documents is stored in FeatureSet objects specific. Specific types of featuresets have specific additional metadata they contain, beyond the standard metadata inferred about all results, and represented by the core FeatureSet class.

Slots

user

character The user who submitted the result

regdate

POSIXct The date/time the result was recorded

analysispkg

list The R package associated with the result (because the working directory was within the package's directory structure).

uniqueid

character The uniqueid of the result

tags

character Additional tags associated with the result

analysisfile

character The .R file active when there result was recorded (RStudio IDE only)

rstudioproject

character The RStudio project active when the result was recorded (RStudio IDE only)

generatedin

character The uniqueid of the Rmd file the result was generated in, if applicable

code

character The code used to generate the result (by default, as captured by histry)

codeinfo

ScriptInfo the ScriptInfo for the code

sessioninfo

sinfoOrList The session info at the time the result was recorded

isplot

logical Whether the result is a plot

fsetklass

character The FeatureSet subclass for the result

trackrversion

character The exact version of the trackr package used to record the result.

clineargs

character The commandline arguments passed to R when starting the session the result was recorded from

resultURI

character The URI associated with the result, see featureset constructor documentation.

extrametadata

list Any extra metadata associated with the result.

titles

Title and subtitle of the plot object; a named list of the form list(main = "My title", sub = "My subtitle").

klass

character The R object class of the result

object

ANY The object itself, or NULL if the object is not available.

vars

character The variable names for a data.frame result

varclasses

character the variable classes for a data.frame result

varsummaries

list summaries for

object

ANY The object itself, or NULL if the object is not available.

data

A list of data.frames containing the variables and observations used in the plot.

varlabels

Variable labels of the plot object; a named list of the form list(x = "X axis label", y = "Y axis label", groups = list(...)). Note that non-empty labels are character vectors and may contain more than one entry.

annotation.text

Annotation text of the plot object.

vartypes

Variable types of the plot object; a named list of the form list(x = "numeric", y = "factor", ...).

grouping

Grouping information on the plot object; a named list.

coordsys

A character vector describing the coordinate system employed in the plot.

nobs

An integer representing the number of observations in the plotted data.

haslegend

A boolean indicating whether or not a legend is displayed in the plot.

tags

A character vector of user-defined tags.

code

R code to reproduce the plot, as a CodeDepends::Script object. May be empty.

codeinfo

Information about the R code to reproduce the plot, as a CodeDepends::ScriptInfo object. May be empty.

geom

A named list of parameters for geometric objects in each layer of the ggplot.

stat

A named list of parameters for statistical transforms in each layer of the ggplot.

position

A named list of positioning information in each layer of the ggplot.

num.layers

An integer representing the number of layers in the plot.

trackr documentation built on May 24, 2021, 5:09 p.m.