create.constraints: Generate common order constraints

Description Usage Arguments Details Value Note See Also Examples

View source: R/create.constraints.r

Description

Automatically generates the constraints in the format used by clme. Allowed orders are simple, simple tree, and umbrella orders.

Usage

1
create.constraints(P1, constraints)

Arguments

P1

the length of theta_1, the vector constrained coefficients.

constraints

List with the elements order, node, and decreasing. See Details for further information.

Details

The elements of constraints are:

See clme for more information and a depiction of these three elements.

Value

The function returns a list containing the elements of input argument constraints as well as

See w.stat for more information on B

Note

The function clme also utilizes the argument constraints. For clme, this argument may either be identical to the argument of this function, or may be the output of create.constraints (that is, a list containing appropriate matrices A, Anull, and if necessary, B).

An example the the A matrix might be:

[1,] [,1] [,2]
[2,] 1 2
[3,] 2 3
[4,] 4 3
[5,] 5 4
[6,] 6 5

This matrix defines what CLME describes as a decreasing umbrella order. The first row defines the constraint that theta_1 <= theta_2, the second row defined the constraint theta_2 <= theta_3, the third row defines theta_4 <= theta_3, and so on. The values are indexes, and the left column is the index of the parameter constrained to be smaller.

See Also

clme, w.stat

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 
  # For simple order, the node does not matter
  create.constraints( P1 = 5, constraints = list( order='simple' , 
                                                  decreasing=FALSE ))
  
  # Compare constraints against decreasing=TRUE
  create.constraints( P1 = 5, constraints=list( order='simple' , 
                                                decreasing=TRUE ))
  
  # Umbrella order
  create.constraints( P1 = 5, constraints=list( order='umbrella' , node=3
                                                , decreasing=FALSE ))

## End(Not run)

CLME documentation built on July 8, 2020, 5:49 p.m.