Session: Class 'Session'.

In anchored-inversion/examples.R: Anchored Inversion Client

Description

This is the main entry point that the user (the "client") uses to communicate with the Anchored Inversion server. The user would create a new 'Session' object by 'Session$new()', then call the object's methods to communicate with the server.

Details

This uses the OOP style of programming provided by the package 'R6'. This is an OOP system that is very different from R's built-in 'S3' and 'S4' systems. It is close to the OOP style of mainstream languages such as 'Python', 'Java', and 'C++'. This style is convenient for the object to persist connection states as the client-server communication progresses.

Some methods of this class are simple wrappers of corresponding functions in the public API. Please see the API reference for more details.

Methods

new(base_url)

Instantiate the class.

Arguments:

base_url

Base URL portion of the API server. The general user should ignore this.

Value:

A new instance of the Session class.

login_demo

Log into demo account.

See API reference for details.

set_project(project_id)

Set the project_id of the project to work on.

See API reference for details.

clear_models()

Clear all model iterations in this project.

See API reference for details.

init_models(grid, field_value_range, data_forward, data_linear)

Initiate the model iteration.

See API reference for details.

update_models(n_samples, f_forward)

Iterate the model.

n_samples

Number of field realizations to request and use for this iteration.

f_forward

Function of the forward process. This function must take one field realization and return a vector of the forward values.

See 'request_fields', 'submit_forwards', and 'update' in API reference for more details.

summarize_project()

Obtain a summary of the model iterations of the project.

simulate_fields(n)

Request field realizations (i.e. simulations).

See API reference for details.

logout()

Log out of the current user account.

See API reference for details.

Properties

projects()

Obtain a vector of the IDs of all the projects in the account that is currently logged in.

project_id()

Obtain the project_id that is set in the latest call to set_project.

anchored-inversion/examples.R documentation built on May 12, 2019, 2:39 a.m.