coef.btfit | R Documentation |
coef
method for class "btfit"
## S3 method for class 'btfit' coef(object, subset = NULL, ref = NULL, as_df = FALSE, ...)
object |
An object of class "btfit", typically the result |
subset |
A condition for selecting one or more subsets of the components. This can either be a character vector of names of the components (i.e. a subset of |
ref |
A reference item. Either a string with the item name, or the number 1, or NULL. If NULL, then the coefficients are constrained such that their mean is zero. If an item name is given, the coefficient estimates are shifted so that the coefficient for the ref item is zero. If there is more than one component, the components that do not include the ref item will be treated as if ref = NULL. If ref = 1, then the first item of each component is made the reference item. |
as_df |
Logical scalar, determining class of output. If TRUE, the function returns a data frame. If FALSE (the default), the function returns a named vector (or list of such vectors). |
... |
other arguments |
Note that the values given in the estimate
column of the item_summary
element are NOT the same as the values in object$pi
. Rather, they are the λ_i, where λ_i = \log{π_i}. By default, these are normalised so that mean(λ_i) = 0. However, if ref
is not equal to NULL
, then the λ_i in the component in which ref
appears are shifted to λ_i - λ_{ref}, for i = 1, …, K_c, where K_c is the number of items in the component in which ref
appears, and λ_{ref} is the estimate for the reference item.
If as_df = TRUE, a data frame a numeric vector of estimated coefficients, where the first column is the component the item is in, the second column in the item and the third column in the coefficient. If as_df = FALSE, then a numeric vector is returned if the model is fitted on the full dataset, or else a list of numeric vectors is returned, one for each fully connected component. Within each component, the items are arranged by estimate, in descending order.
Ella Kaye
citations_btdata <- btdata(BradleyTerryScalable::citations) fit1 <- btfit(citations_btdata, 1) coef(fit1) toy_df_4col <- codes_to_counts(BradleyTerryScalable::toy_data, c("W1", "W2", "D")) toy_btdata <- btdata(toy_df_4col) fit2a <- btfit(toy_btdata, 1) coef(fit2a) coef(fit2a, subset = function(x) length(x) > 3, as_df = TRUE) coef(fit2a, subset = function(x) "Amy" %in% names(x)) coef(fit2a, as_df = TRUE) fit2b <- btfit(toy_btdata, 1.1) coef(fit2b) coef(fit2b, ref = "Cyd")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.