R/document_colnames.R

In multiRL: Reinforcement Learning Tools for Multi-Armed Bandit

#' @title Column Names
#' @name colnames
#' @description 
#'  
#'  Users must categorize and inform the program of the column names within 
#'    their dataset.
#'    
#' @section Class: 
#' \code{colnames [List]} 
#'    
#' @section Slots:  
#' \enumerate{
#'    \item \code{subid [Character]}  
#'    
#'          The column name of subject identifier.
#'          
#'          Column name that is exactly "Subject" can be recognized 
#'          automatically.
#'          
#'    \item \code{block[Character]} 
#'    
#'          The column name of block index.
#'          
#'          Column name that is exactly "Block" can be recognized 
#'          automatically.
#'          
#'    \item \code{trial[Character]} 
#'    
#'          The column name of trial index.
#'          
#'          Column name that is exactly "Trial" can be recognized 
#'          automatically.
#'          
#'    \item \code{object [CharacterVector]}  
#'    
#'          The column names of objects presented in the task, with individual 
#'          elements separated by underscores ("_"). 
#'          
#'          Column names that are prefixed with "Object_" can be recognized 
#'          automatically.
#'          
#'    \item \code{reward [CharacterVector]} 
#'    
#'          The column names of the reward associated with each object; ensure 
#'          that every object has its own corresponding reward.
#'          
#'          Column names that are prefixed with "Reward_" can be recognized 
#'          automatically.
#'          
#'    \item \code{action [Character]} 
#'    
#'          The column name of the action taken by the agent, which must match 
#'          an object or one of its elements.
#'          
#'          Column name that is exactly "Action" can be recognized 
#'          automatically.
#'          
#'    \item \code{exinfo [CharacterVector]} 
#'    
#'          The column names of extra information that the model may use during 
#'          the markov decision process.
#' }
#' 
#' @section Tips:  
#'  Users can use these variables within the model's functions. see 
#'    \href{https://yuki-961004.github.io/multiRL/articles/Step_1_run_m.html}{tutorial}.
#' 
#' @section Example: 
#' \preformatted{ # column names
#'  colnames = list(
#'    subid = "Subject", 
#'    block = "Block", 
#'    trial = "Trial",
#'    object = c("Object_1", "Object_2", "Object_3", "Object_4"), 
#'    reward = c("Reward_1", "Reward_2", "Reward_3", "Reward_4"), 
#'    action = "Action",
#'    exinfo = c("Frame", "NetWorth", "RT", "Mood")
#'  )
#' }
NULL