[inlinedocs] inlinedocs setClass
David Gibbs
gibbsd at ohsu.edu
Thu Aug 11 00:15:26 CEST 2011
Hi there,
When using package.skeleton.dx("myPkg") with the setClass method,
the title field is not being written to the Rd file. Without the title, the check
function complains and quits. I'm on OS X Lion, btw.
Maybe an additional argument not to clobber existing files would be nice.
Then I wouldn't have to fix this over and over.
Thanks!! Let me know if you need any additional info.
-dave
Here's what's happening:
setClass("pepnet",
### The pepnet class will hold all the results from peptide network calculations
representation(adjmat = "matrix", ##<< the adjacency matrix
tom = "matrix", ##<< the topological overlap matrix
peptides = "character" ##<< the names of the peptides
)
)
> package.skeleton.dx("RPepCor/")
extra.code.docs prefixed.lines extract.xxx.chunks title.from.firstline examples.from.testfile definition.from.source edit.package.file author.from.description erase.format title.from.name examples.in.attr collapse tag.s3methods
Creating directories ...
Creating DESCRIPTION ...
Creating Read-and-delete-me ...
Copying code files ...
Making help files ...
Done.
Further steps are described in './RPepCor/Read-and-delete-me'.
Modifying files automatically generated by package.skeleton:
c2i: definition description item{nrows} item{x} item{y} value author format title
compareModules: definition description value item{net1} item{net2} item{pep1} item{pep2} author format title
i2c: definition description item{nrows} item{i} value author format title
i2col: definition description item{nrows} item{i} value author format title
pepNames: definition description value item{p} author format title
pepnet-class: item{adjmat} item{tom} item{peptides} title description details section{Objects from the Class} seealso alias author format
RPepCor-package: title description tabular{ll} author format
\name{pepnet-class}
\Rdversion{1.1}
\docType{class}
\alias{pepnet-class}
\alias{pepnet}
\alias{names,pepnet-method}
\description{The pepcor class will hold all the results from peptide network calculations}
\section{Objects from the Class}{Objects can be created by calls of the form \code{new(pepnet ...)}}
\section{Slots}{
\describe{
\item{\code{adjmat}:}{(\code{matrix}) the adjacency matrix}
\item{\code{tom}:}{(\code{matrix}) the topological overlap matrix}
\item{\code{peptides}:}{(\code{character}) the names of the peptides, usually AMT IDs}
}
}
\section{Methods}{
\describe{
\item{names}{\code{signature(x = "pepnet")}: ... }
}
}
\author{David Gibbs <gibbsdavidl at gmail.com>}
More information about the Inlinedocs-support
mailing list