HImeanactabs: HImeanactabs: this function calculates the absolute mean...

In Laterality: Functions to Calculate Common Laterality Statistics in Primatology

HImeanactabs: this function calculates the absolute mean Handedness Index for each activity.

Description

Calculates the absolute mean Handedness Index for each task performed and plots the corresponding histogram. The results can be saved in a .csv file.

Usage

  HImeanactabs(data, catch = "Food", hand = "Hand", indiv = "Indiv",
  RightHand = "R", LeftHand = "L", col = 2:((length(levels
  (data[[catch]]))) + 1), ylab = "Mean handedness index", 
  main = "Hand preference regarding to the performed task", 
  legend.text = FALSE, beside = TRUE, ylim = c(-1, 1), names.arg=levels(data[[catch]]), 
  legendlocation = FALSE, standarderror=TRUE, cex = 1, pt.cex = 2, pch = 15, 
  horiz = FALSE, savetable = FALSE, file = "HImeanPerActabs.csv")

Arguments

data	The object (data.frame) containing your data with at least the qualitative variables concerning the hand used (hand), the individuals (indiv) and the activity performed (catch).
catch	The name/header of the column concerning the activity carried out (by default "Food"), if you made individuals catching different objects (ob1, ob2, ob3, ob4) and named the variale "ObjectCatched", write catch = "ObjectCatched".
hand	The name/header of the column concerning the hand used (by default "Hand").
indiv	The name/header of the column concerning the individuals (by default "Indiv").
RightHand	The code used in the database (and particularly in the "hand" variable) for "RightHand". If "RightHand" is coded as "Right" write RightHand = "Right" (by default "R").
LeftHand	The code used in the database (and particularly in the "hand" variable) for "LeftHand". If "LeftHand" is coded as "Left" write LeftHand = "Left" (by default "L").
col	A list of color for the bars of the histogram. By default it will automatically find the number of colors you need but it's using the 8 colors of the default palette of R. If you need more don't forget to select another palette or to name the color you want to add.
ylab	A title for the y axis.
main	The main title of the graph.
legend.text	If legend.text = TRUE, the legend will be automatically placed on the graph. If legend.text = FALSE, no legend will appear except if legendlocation = TRUE.
beside	If FALSE, the columns of height are portrayed as stacked bars, and if TRUE the columns are portrayed as juxtaposed bars.
ylim	The minimum and maximum value of the y axis. For example ylim = c(0,500). By default (ylim = NULL) the values are automatically selected.
names.arg	Plot the name of the arguments under each bar of the barplot. If names.args=FALSE, one should choose to turn to TRUE legend.text or legendlocation.
legendlocation	If TRUE you will have to click where you want to place the legend after the plot is done.
standarderror	If standarderror=TRUE standard error bars will be plotted for each bar of the barplot.
cex	A numeric giving the size of the legend characters.
pt.cex	A numeric giving the size of the legend points.
pch	This can either be a single character or an integer code for one of a set of graphics symbols. This will be applied to the legend. (By default pch = 15 which is square).
horiz	If horiz = TRUE, the legend will be displayed horizontally (by default). If horiz = FALSE, the legend will be displayed vertically.
savetable	This arguments permits to save directly the results of the function in a .csv file in the workspace of R. If savetable = "csv" there will be "." for the decimal point and a "," for the separator. If savetable = "csv2" there will be "," for the decimal point and a ";" for the separator. (by default savetable = FALSE)
file	This argument will work if savetable = "csv" or "csv2". It gives the name of the csv file saved (by default file = "HImeanPerActabs.csv")

Value

The function returns results of class "data.frame".

Author(s)

Borel A., Pouydebat E., Reghem E. <[e-mail]>

Examples

  ## With arguments corresponding to the default ones:
  data(laterdata)
  str(laterdata)
  Data<-laterdata
  HImeanactabs(Data, catch="Food", hand="Hand", indiv = "Indiv", 
  RightHand = "R", LeftHand = "L")
  ## or
  HImeanactabs(Data)

  ## With arguments different from the default ones:
  data(lateradata)
  str(lateradata)
  Data<-lateradata
  HImeanactabs(Data, catch="Act", hand="HandPref", indiv = "Individual", 
  RightHand = "Right", LeftHand = "Left")

Laterality documentation built on Sept. 11, 2024, 6:53 p.m.