dice.combinations {Rdice} | R Documentation |
Dice combinations
Description
Calculates all possible combinations as result of rolling a set of dice. Similar permutations are identified under the same combination and counted as many times as many occurrencies. Thee user can choose wheter to match exact values or to perform partial matches.
Usage
dice.combinations(faces, dice, rolls, weights, getPartial, getExact, toSum = FALSE)
Arguments
faces |
The number of faces the dice have; if unspecified, it defaults to 6. |
dice |
The number of dice to roll; if unspecified, it defaults to 2. |
rolls |
The number of times to roll the die; if unspeciefid, it defaults to 5. |
weights |
A vector of probability weights to assign to each face of the die; if unspecified, it defaults to a fair die with weights |
getExact |
A vector containing values to be matched exactly, namely the function returns only those combinations containing all the above mentioned variables. |
getPartial |
A vector containing values to be matched partially, namely the function returns only those combinations containing at least one of the above mentioned variables. If missing, it defaults to c(1:faces), namemly the function returns all combinations. |
toSum |
A logical value, defaulting to FALSE. If TRUE, the function returns the sum of the frequencies of the matches (to be used together with getExact or getPartial) |
Details
The function returns an object of class diceRoll, namely a list whose values are themselves data.table
objects, in turn, so that one can directly apply any data.table
function thereupon.
Value
values |
If toSum = FALSE, a list of all possible combinations rolled, together with corresponding frequencies. If toSum = TRUE, the function returns the sum of all frequencies in correspondence of matched valules. |
Note
The case face = 2 corresponds to the coin.flip
.
See Also
Makes use of dice.roll
.
Examples
dice.combinations(faces = 6, dice = 4, rolls = 100,
getExact = c(3,5), getPartial = c(1,2), toSum = TRUE)