Package index • predped

Classes

agent-class agent: An S4 Class to Represent Agents.
background-class background: An S4 Class to Represent the Background
circle-class circle: An S4 Class to Represent Circle Objects
coordinate-class coordinate: An S4 Class to Represent Coordinate Vectors
goal-class goal: An S4 Class to Represent Goals
initialize(<agent>): Constructor for the agent-class
initialize(<background>): Constructor for the background-class
initialize(<circle>): Constructor for the circle-class
initialize(<coordinate>): Constructor for the coordinate-class
initialize(<goal>): Constructor for the goal-class
initialize(<object>): Constructor for the object-class
initialize(<polygon>): Constructor for the polygon-class
initialize(<predped>): Constructor for the predped-class
initialize(<rectangle>): Constructor for the rectangle-class
initialize(<segment>): Constructor for the segment-class
initialize(<state>): Constructor for the state-class
object-class: An S4 Abstract Base Class to Represent Objects
polygon-class polygon: An S4 class to Represent Polygon Objects
predped-class predped: An S4 Class to Represent the M4MA model.
rectangle-class rectangle: An S4 Class to Represent Rectangle Objects
segment-class segment: An S4 class to Represent Lines
state-class state: An S4 Class to Represent the State

General Methods

plot(<agent>) plot(<background>) plot(<list>) plot(<object>) plot(<segment>) plot(<state>): Plot an object
show(<agent>): Show method for the agent-class
show(<background>): Show method for the background-class
show(<goal>): Show method for the goal-class
show(<predped>): Show method for the predped-class

Object Manipulation

add_nodes(): Add Nodes along the Outside or Inside of an Object
area(): Calculate the Area of an Object
enlarge(): Make an Object Larger
in_object(): Check Whether a Point Lies Within an Object
in_object_rcpp(): Check Whether a Point Lies Within an Object
intersects(): Check whether an Object intersects with Other Object
line_intersection(): Check whether an Object intersects with Line Segments
move(): Move object to new location
nodes_on_circumference(): Add Nodes on the Circumference of an Object
nodes_on_circumference_rcpp(): Add Nodes on the Circumference of an Object
out_object(): Check Whether a Point Lies Outside of an Object
rng_point(): Sample a Random Point on the Circumference
rotate(): Rotate object around center

Goal Manipulation

add_goal(): Add a goal to an object
change(): Change a goal
goal_stack(): Generate a goal stack
interact(): Interact with goal
multiple_goal_stacks(): Generate multiple goal stacks

Simulation

add_agent(): Add a single agent to the simulation
add_group(): Add a group of agents to the simulation
create_initial_condition(): Create initial condition
simulate(<predped>): Simulate the M4MA
simulate(<state>): Simulate a single state for the M4MA
update(<agent>): Update Agent
update(<state>): Update State
update_goal(): Update the Goal of an Agent
update_position(): Update the Position of an Agent

Estimation

mll(): Compute the min-log-likelihood
mll_rcpp(): Compute the min-log-likelihood

Movement

agents_between_goal(): Find number of agents blocking agent
best_angle(): Look for the best direction to head in
compute_centers(): Compute cell centers
compute_centers_rcpp(): Compute cell centers
moving_options(): Check where an object can be moved to
moving_options_rcpp(): Check where an object can be moved to
overlap_with_objects(): Check agent and object overlap
overlap_with_objects_rcpp(): Check agent and object overlap
predict_movement(): Predict agents' movement
predict_movement_rcpp(): Predict agents' movement

Routing

adjust_edges(): Adjust edges of graph to walk on
compute_edges(): Compute the edges within a given setting
compute_limited_access(): Transform segments to polygons
create_edges(): Create edges of graph to walk on
create_nodes(): Create nodes that serve as path points
evaluate_edges(): Evaluate whether edges pass through objects
find_path(): Find path to a goal
limit_access(): Compute which segments can be crossed
prune_edges(): Evaluate intersections with objects

Utility Framework

compute_utility_variables(<agent>) compute_utility_variables(<data.frame>): Compute utility variables
compute_utility_variables_rcpp(): Compute utility variables
distance_group_centroid(): Distances to group centroid
distance_group_centroid_rcpp(): Distances to group centroid
gc_utility(): Group centroid utility
gc_utility_rcpp(): Group centroid utility
get_angles(): Angle between agent and group members
get_angles_rcpp(): Angle between agent and group members
utility(<agent>): Compute the utilities on the agent level
utility(<data.frame>): Compute the utilities with all utility variables known
utility_agent_rcpp(): Utility
utility_rcpp(): Utility
vf_utility_continuous(): Continuous visual field utility
vf_utility_discrete(): Discrete visual field utility
vf_utility_rcpp(): Discrete visual field utility

Parameters

generate_parameters(): Generate parameters
load_parameters(): Load parameters
params_from_csv: Default Parameter List
plot_distribution(): Plot prior parameter distributions
to_bounded(): Transform to positive axis
to_covariance(): Transform user-provided matrix to covariance matrix
to_unbounded(): Transform to real axis
transform_mu(): Transform nest association to precision (mu)

Data Transformation

add_motion_variables(): Add motion variables to data
time_series(): Transform trace to time-series
time_series_rcpp(): Transform trace to time-series
to_trace(): Transform data to a trace
unpack_trace(): Transform trace to comprehensive data.frame
unpack_trace_rcpp(): Transform trace to comprehensive data.frame

Helper Functions

benchmark(): Benchmark the package
combine_nodes(): Make combinations of different nodes
create_agent_specifications(): Create agent specifications
create_agent_specifications_rcpp(): Create agent specifications
determine_values(): Determine iterated values from various arguments
find_class(): Find all objects of a given class
line_line_intersection(): Compute the line-line intersection between several segments. Is a vectorized function with minimal loss of time when the number of segments to test increases.
line_line_intersection_rcpp(): Rcpp version of line_line_intersection. Computes the between several segments. Is a vectorized function with minimal loss of time when the number of segments to test increases.
perpendicular_orientation(): Find the perpendicular orientation
plot_edges(): Plot the edges in a background-class
raycasting(): Raycasting algorithm
transform_df(): Transform to dataframe of segments

Getters and Setters

agents() `agents<-`(): Getter/Setter for the agents-slot
archetypes() `archetypes<-`(): Getter/Setter for the archetypes-slot
busy() `busy<-`(): Getter/Setter for the busy-slot
cell() `cell<-`(): Getter/Setter for the cell-slot
cell_centers() `cell_centers<-`(): Getter/Setter for the cell_centers-slot
center() `center<-`(): Getter/Setter for the center-slot
color() `color<-`(): Getter/Setter for the color-slot
counter() `counter<-`(): Getter/Setter for the counter-slot
current_goal() `current_goal<-`(): Getter/Setter for the current_goal-slot
done() `done<-`(): Getter/Setter for the done-slot
entrance() `entrance<-`(): Getter/Setter for the entrance-slot
exit() `exit<-`(): Getter/Setter for the exit-slot
forbidden() `forbidden<-`(): Getter/Setter for the forbidden-slot
from() `from<-`(): Getter/Setter for the from-slot
goals() `goals<-`(): Getter/Setter for the goals-slot
group() `group<-`(): Getter/Setter for the group-slot
id() `id<-`(): Getter/Setter for the id-slot
iteration() `iteration<-`() `iteration_variables<-`(<state>): Getter/Setter for the iteration-slot
iteration_variables() `iteration_variables<-`(): Getter/Setter for the iteration_variables-slot
limited_access() `limited_access<-`(): Getter/Setter for the limited_access-slot
`objects<-`() objects(<background>): Getter/Setter for the objects-slot
orientation() `orientation<-`(): Getter/Setter for the orientation-slot
parameters() `parameters<-`(): Getter/Setter for the parameters-slot
path() `path<-`(): Getter/Setter for the path-slot
`points<-`() points(<polygon>) points(<rectangle>) points(<circle>) points(<segment>): Getter/Setter for the points-slot
position() `position<-`(): Getter/Setter for the position-slot
potential_agents() `potential_agents<-`(): Getter/Setter for the potential_agents-slot
radius() `radius<-`(): Getter/Setter for the radius-slot
setting() `setting<-`(): Getter/Setter for the setting-slot
shape() `shape<-`(): Getter/Setter for the shape-slot
size() `size<-`(): Getter/Setter for the size-slot
speed() `speed<-`(): Getter/Setter for the speed-slot
status() `status<-`(): Getter/Setter for the status-slot
to() `to<-`(): Getter/Setter for the to-slot
utility_variables() `utility_variables<-`(): Getter/Setter for the utility_variables-slot
variables() `variables<-`(): Getter/Setter for the variables-slot
waiting_counter() `waiting_counter<-`(): Getter/Setter for the waiting_counter-slot
weights() `weights<-`(): Getter/Setter for the weights-slot