Man pages for dymium-org/dymiumCore
A Toolkit for Building a Dynamic Microsimulation Model for Integrated Urban Modelling
| add_entity | Add new records to an Entity object |
| add_history | Add history to Entity |
| add_log | Add log to a Container or Entity object |
| Agent | Agent class |
| alignment | Alignment |
| Asset | Asset class |
| Building | Building class |
| BuildingCommercial | Commercial Building class |
| BuildingIndustrial | Industrial building class |
| BuildingResidential | Building Residential class |
| check_entity | Check if an argument is from the Entity class. |
| check_entity_ids | Check if ids exist in Entity. |
| check_module | Check if a module exists in a remote repository |
| check_module_version | Check the existence of a module version. |
| check_required_models | Check if an argument x has all the required models |
| check_subset2 | Check subset2 |
| check_target | Check if argument is a valid target object |
| check_transition_supported_model | Check if an argument is an object that is supported by Trans |
| combine_histories | Combine history data of Entities into a single data.frame. |
| condense_rows | Condense rows |
| Container | Container |
| ContainerGeneric | ContainerGeneric |
| create_scenario | Create, set, and get scenario. |
| create_toy_population | Create a loaded population object |
| create_toy_world | create toy world |
| DataBackend | DataBackend class |
| DataBackendDataFrame | data.frame as data backend |
| DataBackendDataTable | data.table::data.table as data backend |
| DataBackendSpatialFeature | sf::sf as data backend |
| dm_get_model | Get model objects from World. |
| dm_save | Save an instance of Entity or Container. |
| download_module | Download a module from a repository. |
| dsample | Discrete choice sampling |
| dt_group_and_sort | Group a column into a list column and sort by the group-by... |
| dymiumCore | dymiumCore package |
| element_wise_expand_lists | element_wise_expand_lists |
| Entity | Entity class |
| Environment | Environment class |
| extract_data | Extract data from Entity objects |
| Firm | Firm class |
| Generic | Generic class |
| get_all_module_files | Get all files from all modules in a repository. |
| get_history | Get Entity history |
| get_models | Get model objects from World. |
| get_module_files | Get all files from a module |
| get_modules | Get the names of available modules from a remote repository |
| get_module_versions | Get all version numbers of a module |
| get_sim_time | Get the current timestep of the simulation This function... |
| Household | Household class |
| Individual | Individual class |
| inspect | Inspect Entity |
| is_dymium_class | is dymium class |
| is_scheduled | has the event been scheduled? |
| lookup_and_replace | Look up and replace values in columns, including list... |
| lookup_and_replace2 | Look up and replace values in columns. |
| makeModel | make Model |
| MatchingMarket | Matching Market Class |
| MatchingMarketOptimal | Optimal Matching Market |
| MatchingMarketStochastic | Stochastic Matching Market |
| Model | Model class |
| ModelBinaryChoice | ModelBinaryChoice |
| ModelCustom | ModelCustom |
| ModelLinear | ModelLinear |
| ModelMultinomialLogit | ModelMultinomialLogit |
| mutate_entity | Mutate entities |
| Network | Network class |
| normalise_derived_vars | Normalise the names of derived variables |
| omit_derived_vars | Omit derived variables from a data.frame |
| pick_models | Pick models |
| pipe | Pipe operator |
| Pipeline | Pipeline |
| plot_history | Plot history data |
| pop_register | Population register |
| Population | Population |
| predict.ModelMultinomialLogit | predict method for ModelMultinomialLogit |
| register | Assign new ids to data |
| remove_entity | Remove entity |
| sample_choice | Modified version of base::sample for programming in a Monte... |
| sim | Compile and execute a microsimulation pipeline |
| simulate_choice | Simulate a choice situation |
| SupportedTransitionModels | Get all object classes that are supported by Transition |
| Target | Target |
| toy_dwellings | Toy dwelling microdata |
| toy_households | Toy household microdata |
| toy_individuals | Toy individual microdata |
| toy_transport_network | Toy transport network data |
| toy_zones | Toy zone data |
| Trans | Transition class |
| transition | Simulate state transition (Markov chain) |
| TransitionClassification | Transition for a classification model |
| TransitionRegression | Transition for regression model |
| unnest_datatable | unnest data.table by reference column(s). |
| unnest_dt | Unnest data.table by list columns |
| use_event | Create an event. |
| use_module | Create and setup a module folder. |
| use_module_readme | Add a README rmarkdown file to an existing module |
| validate_linkages | Validate the linkages between Entities in World |
| which_max_n | Return the indices of n maximum or minimum values |
| World | A representation of World |
| Zone | Zone class |
