search for: seealso

Full_Name: Henrik Bengtsson Version: 1.3.1 OS: WinMe Submission from: (NULL) (130.235.2.229) I suggest the following \seealso to be added for savehistory: \seealso{ To execute \code{savehistory} automatically when \R quits see \link{.Last} and \link{.Rprofile}. } -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.- r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html...

...on \arguments prepare_Rd: CellProfile-R-internal.Rd:22: Dropping empty section \value prepare_Rd: CellProfile-R-internal.Rd:25: Dropping empty section \note prepare_Rd: CellProfile-R-internal.Rd:23: Dropping empty section \references prepare_Rd: CellProfile-R-internal.Rd:29: Dropping empty section \seealso prepare_Rd: CellProfile-R-internal.Rd:30: Dropping empty section \examples prepare_Rd: CellProfile-R-package.Rd:43: Dropping empty section \seealso prepare_Rd: CellProfile-R-package.Rd:44: Dropping empty section \examples prepare_Rd: createUnifiedTable.Rd:59-61: Dropping empty section \note prepare...

Here is an updated version of the S doc -> R doc script. New features are automatic conversion of `xxx' to LANG(xxx) or LANG(LINK(xxx)) in SEEALSO sections, respectively (thanks to Martin and Thomas for the suggestions). The keywords are saved as comments, and can easily be used as soon as keywords are supported. As usual, any feedback ... -k ********************************************************************** #!/usr/bin/perl -w $VERSI...

...forward to receiving them. On Tue, 10 Apr 2007, timh at insightful.com wrote: > I've created a .Rd file (below), then converted that to .sgml using > R CMD Rdconv --type=Ssgm combn.Rd > combn.sgml > The output (shown below) is missing some of the sections: > arguments > seealso > examples > If instead I convert to .d (below), the same sections are missing, > and the "note" section is included but without the necessary newline. > > -------------------------------------------------- > \name{combn} > \alias{combn} > \title{ Generate combina...

...On Tue, 10 Apr 2007 timh at insightful.com wrote: > > > I've created a .Rd file (below), then converted that to .sgml using > > R CMD Rdconv --type=Ssgm combn.Rd > combn.sgml > > The output (shown below) is missing some of the sections: > > arguments > > seealso > > examples > > If instead I convert to .d (below), the same sections are missing, > > and the "note" section is included but without the necessary newline. > > The underlying problem was that there were some unmatched open-braces. > (or 'brackets'?) T...

On Tue, 10 Apr 2007 timh at insightful.com wrote: > I've created a .Rd file (below), then converted that to .sgml using > R CMD Rdconv --type=Ssgm combn.Rd > combn.sgml > The output (shown below) is missing some of the sections: > arguments > seealso > examples > If instead I convert to .d (below), the same sections are missing, > and the "note" section is included but without the necessary newline. The underlying problem was that there were some unmatched open-braces. (or 'brackets'?) The attached patch to share/pe...

I've created a .Rd file (below), then converted that to .sgml using R CMD Rdconv --type=Ssgm combn.Rd > combn.sgml The output (shown below) is missing some of the sections: arguments seealso examples If instead I convert to .d (below), the same sections are missing, and the "note" section is included but without the necessary newline. -------------------------------------------------- \name{combn} \alias{combn} \title{ Generate combinations of m elements out of x } \descrip...

I have two straightforward questions about linking in the man pages for R packages: First, is it possible to link from within parts of the documentation that are not the \seealso section? For example, I would like to have something like: \arguments{ \item{correlation}{an optional \code{corStruct} object describing the within-group correlation structure; the available classes are given in \link{\code{corClasses}}} } When the package is compiled, the word corClasses is blu...

Attached is the current version of my sd2rd perl script. It has passed tests by Martin, Fritz and myself, and seems to work reasonably well (it should get the arguments lists right, distinguish between VALUE and VALUES, and know about REFERENCES and SEEALSO). Any comments etc are most welcome. -k ************************************************************************ #!/usr/bin/perl -w $\ = "\n"; $parenLevel = 0; $doprint = 1; $needArg = 1; $needVal = 0; $output = ""; while (<>) { chop; &substitute; @wo...

...use \item{comp1 }{Description of 'comp1'} \item{comp2 }{Description of 'comp2'} ... } \references{ ~put references to the literature/web site here ~ } \author{ ~~who you are~~ } \note{ ~~further notes~~ } ~Make other sections like Warning with \section{Warning }{....} ~ \seealso{ ~~objects to See Also as \code{\link{~~fun~~}}, ~~~ } \examples{ ##---- Should be DIRECTLY executable !! ---- ##-- ==> Define data, use random, ##-- or do help(data=index) for the standard data sets. ## The function is currently defined as function(x,y,z,simplify=TRUE,descrip=FALSE){sta...

...nd-delete-me ... Copying code files ... Making help files ... Done. Further steps are described in './spectral.methods/Read-and-delete-me'. Modifying files automatically generated by package.skeleton: add.axis: definition title description item{side} item{trans.fun} item{label} item{\dots} seealso author format best.iter.default: definition description item{perf.matrix} details seealso author value format title determine.freq: title description item{series} item{plot.periodogram} <long list of the functions in my package> ... Warning message: In grep(prefix, src) : input string 65 i...

Here?s a patch that adds ?seealso? entries to Sys.time and system.time docs, to help people who forget what the distinction is between them. Patch was made against https://svn.r-project.org/R/trunk at 61454 . -Ken

...t;>> Cc: 'Thomas Lumley'; r-help at stat.math.ethz.ch >>> Subject: Re: [R] documenting s4 methods in package >>> >>> >>> On 4/4/2006 1:58 PM, Steven Lacey wrote: >>>> Thomas, >>>> >>>> Correction! If I remove the \seealso line the missing ~~fun~~ >>>> disppears (thank you!), but now "chm" appears at the end of the line >>>> decribing the help page building. Most lines do not have that, only >>>> "text htm1 latex example". What does the chm signify and how do...

Should R/src/library/base/man/Extremes.Rd (where max, min, pmax, pmin are documented) refer to which.min and which.max in the "\seealso" section? e.g. change the \seealso section (line 53) of Extremes.Rd to: \code{\link{range}}, \code{\link{which.min}}, etc.}, [Also, is r-help the right place for suggestions about documentation?] thanks, Stephen Eglen -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-....

...tion... (p.s. I made the diff on the R-2.1.0 source). diff sum.Rd src/library/base/man/sum.Rd --context=2 *** sum.Rd 2005-06-03 20:24:22.468224056 +0100 --- src/library/base/man/sum.Rd 2005-04-18 22:30:27.000000000 +0100 *************** *** 33,38 **** Wadsworth \& Brooks/Cole. } - \seealso{ - \code{\code{\link{colSums}}. - } \keyword{arith} --- 33,35 ----

A link in one of my help files does not work. I have in this help file: \seealso{\code{\link{crit.fun}}, \code{\link{opt.par}}, \code{\link{opt.random.par}}, \code{\link{opt.these.par}}, \code{\link{nkpartitions}}, \code{\link{nkpar}}, \code{\link{plot.check.these.par}} } Everything in one row, the last link does not work. In another help file, I have: \name{plot.mat} \ali...

...r file_test ? Kind regards, Sean O'Riordain ----- Index: src/library/utils/man/filetest.Rd =================================================================== --- src/library/utils/man/filetest.Rd (revision 55639) +++ src/library/utils/man/filetest.Rd (working copy) @@ -35,7 +35,7 @@ } \seealso{ \code{\link{file.exists}} which only tests for existence - (\code{test -e} on some systems) but not for not being a directory. + (\code{test -e} on some systems) but not for being a directory. \code{\link{file.path}}, \code{\link{file.info}} } [[alternative HTML version deleted]]

...uot; ~ Rdtxt$note <- c("\\note{ ~~further notes~~ ", ~ "", ~ paste(" ~Make other sections like Warning with", ~ "\\section{Warning }{....} ~"), ~ "}") ~ Rdtxt$seealso <- paste("\\seealso{ ~~objects to See Also as", ~ "\\code{\\link{help}}, ~~~ }") ~ Rdtxt$examples <- c("\\examples{", ~ "##---- Should be DIRECTLY executable !! ----", ~ "##...

...nary package for Windows that builds, checks, installs and works without errors. In some of my .Rd files, I have links to functions in the standard packages supplied with R as well as links to others in add-on packages that I have installed. For instance, one .Rd file has the following snippet: \seealso{ \code{\link[lattice]{xyplot}}, \code{\link[MASS]{rlm}}, \code{\link[RODBC]{odbcConnect}}} I have installed RODBC in a separate library, pointed to by R_LIBS. The HTML links to xyplot and rlm work fine, but those to packages not in the standard library can't be found (such...

...ed the name and first alias field \name{test} \alias{test} \alias{[<-.massvectorlist} \title{ Replace Parts of Massvectorlist} .... Now a "test" entry appears in the 00Index.html but ...Of course I can give a more appropriate name but... But unfortunately all \link to [<-. in the \seealso section does not work than either. Why no [<-.massvectorlist entry appears in the 00Index.html file? Even if i put [<-.massvector as second alias? Is there a way to get assignments work as other functions? Or is the best solution to give a name like Assign.massvector to the Rd file the name...