File: Rdo_insert.Rd

package info (click to toggle)
r-cran-rdpack 2.6.6-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,156 kB
  • sloc: sh: 13; makefile: 4
file content (67 lines) | stat: -rw-r--r-- 1,325 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
\name{Rdo_insert}

\alias{Rdo_insert}

%- Also NEED an '\alias' for EACH other topic documented here.

\title{
  Insert a new element in an Rd object possibly surrounding it with new
  lines
}

\description{
  Insert a new element in an Rd object possibly surrounding it with new
  lines.
}

\usage{
Rdo_insert(rdo, val, newline = TRUE)
}

%- maybe also 'usage' for other objects documented here.

\arguments{
  \item{rdo}{an Rd object}
  \item{val}{the content to insert, an Rd object.}
  \item{newline}{a logical value, controls the insertion of new lines
    before and after \code{val}, see `Details'.
  }
}

\details{

  Argument \code{val} is inserted in \code{rdo} at an appropriate
  position, see \code{\link{Rdo_get_insert_pos}} for detailed
  explanation.

  If \code{newline} is TRUE, newline elements are inserted before and
  after \code{val} but only if they are not already there.

  Typically, \code{val} is a section of an Rd object and \code{rdo} is
  an Rd object which is being constructed or modified.

}

\value{
  an Rd object
}



\author{Georgi N. Boshnakov}




%% ~Make other sections like Warning with \section{Warning }{....} ~




% Add one or more standard keywords, see file 'KEYWORDS' in the

% R documentation directory.

%\keyword{RdoProgramming}
%\keyword{RdoElements}
\keyword{RdoBuild}