File: newParameterList.Rd

package info (click to toggle)
r-cran-nozzle.r1 1.1-1%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 796 kB
  • sloc: javascript: 553; makefile: 12
file content (38 lines) | stat: -rw-r--r-- 1,313 bytes parent folder | download | duplicates (3)
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
\name{newParameterList}
\alias{newParameterList}
\title{Create a new parameter list element. A parameter list is an unnumbered list of the form param_1 = value_1, ..., param_n = value_n where param_i is formated as a parameter and value_i is formatted as a value.}
\usage{
  newParameterList(..., separator = " = ", exportId = NULL,
    protection = PROTECTION.PUBLIC)
}
\arguments{
  \item{...}{2n strings that will be concatenated to form
  the parameter-value pairs. Strings at positions 1, ...,
  2n - 1 will be treated as parameters 1 through n and
  strings at positions 2, ..., 2n will be treated as values
  1 through n.}

  \item{separator}{String to be used to separate parameters
  and values. Whitespace characters need to be supplied if
  required.}

  \item{exportId}{Unique string to identify this element.
  Used to retrieve the element using
  \code{getExportedElement}.}

  \item{protection}{Procection level. One of
  PROTECTION.PUBLIC, PROTECTION.GROUP, PROTECTION.PRIVATE.}
}
\value{
  New element.
}
\description{
  Create a new parameter list element. A parameter list is
  an unnumbered list of the form param_1 = value_1, ...,
  param_n = value_n where param_i is formated as a
  parameter and value_i is formatted as a value.
}
\author{
  Nils Gehlenborg \email{nils@hms.harvard.edu}
}