individuals: individuals present in the group

View source: R/individuals.r

individualsR Documentation

individuals present in the group

Description

returns IDs, number or IDs, or CV of number of present individuals

Usage

individuals(
  eloobject,
  from = eloobject$misc["maxDate"],
  to = NULL,
  outp = c("N", "IDs", "CV")
)

Arguments

eloobject

result from elo.seq

from

character, from which date onwards should the ID statistics be calculated. By default the first date in the sequence is used

to

character, until which date should the ID statistics be calculated. By default NULL, i.e. the returned information refers to only the date specified by from

outp

character, one of three options to determine which kind of information is returned: (1) "N": the (average) number of individuals present, (2) "IDs": the actual IDs, and (3): "CV": coefficient of number of individuals present

Details

if to=NULL, either the IDs (outp="IDs") or the number of individuals (outp="N") present on this day is returned. outp="CV" is not defined in such a case (returns NA).

if a to date is set (i.e. different from NULL), either the IDs of all individuals that were present on at least one day of the date range (outp="IDs") is returned or the average number of individuals present during this time (outp="N"). If outp="CV", the coefficient of variation of the number of individuals present is returned, which might be considererd another measure of stability on the group level.

Value

numeric or character

Author(s)

Christof Neumann

Examples

data(adv)
SEQ <- elo.seq(winner = adv$winner, loser = adv$loser, Date = adv$Date)
individuals(SEQ, outp = "N")
individuals(SEQ, outp = "IDs")
individuals(SEQ, outp = "CV") # not defined

# consider additional presence information
data(advpres)
SEQ <- elo.seq(winner = adv$winner, loser = adv$loser, Date = adv$Date,
               presence = advpres)
individuals(SEQ, outp = "N")
individuals(SEQ, outp = "IDs")
individuals(SEQ, outp = "CV") # not defined

# across a date range
individuals(SEQ, from = "2010-01-01", to = "2010-01-31", outp = "N")
individuals(SEQ, from = "2010-01-01", to = "2010-01-31", outp = "IDs")
individuals(SEQ, from = "2010-01-01", to = "2010-01-31", outp = "CV")

gobbios/EloRating documentation built on July 19, 2024, 4:05 a.m.