# obtain_permutation_matrix: Obtain Permutation Matrix from a Random Assignment... In DeclareDesign/randomizr: Easy-to-Use Tools for Common Forms of Random Assignment and Sampling

## Description

Obtain Permutation Matrix from a Random Assignment Declaration

## Usage

 `1` ```obtain_permutation_matrix(declaration, maximum_permutations = 10000) ```

## Arguments

 `declaration` A random assignment declaration, created by `declare_ra`. `maximum_permutations` If the number of possible random assignments exceeds maximum_permutations, obtain_permutation_matrix will return a random sample of maximum_permutations permutations. Defaults to 10,000.

## Value

a matrix of all possible (or a random sample of all possible) random assignments consistent with a declaration.

## Examples

 ``` 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``` ```# complete declaration <- declare_ra(N = 4) perms <- obtain_permutation_matrix(declaration) dim(perms) obtain_num_permutations(declaration) # blocked blocks <- c("A", "A", "B", "B", "C", "C", "C") declaration <- declare_ra(blocks = blocks) perms <- obtain_permutation_matrix(declaration) dim(perms) obtain_num_permutations(declaration) # clustered clusters <- c("A", "B", "A", "B", "C", "C", "C") declaration <- declare_ra(clusters = clusters) perms <- obtain_permutation_matrix(declaration) dim(perms) obtain_num_permutations(declaration) # large declaration <- declare_ra(20) choose(20, 10) perms <- obtain_permutation_matrix(declaration) dim(perms) ```

DeclareDesign/randomizr documentation built on June 2, 2019, 3:50 p.m.