Learn R Programming

Rexperigen

An R interface for downloading results from an Experigen server. Works with the "classic" server that is currently running on db.experigen.org as well, but its main advantage is that it helps a lot with the new functions of the newer version of the Experigen server. Most importantly, it helps with registration of experimenters, registration of experiments and accessing their data.

Setup

Key setup functions are:

  • setExperigenServer: sets the URL of the server where the data is stored. The default currently is db.phonologist.org
  • setExperigenCredentials (server version >=2 only): sets the experimenter username and password for access to registered data
  • registerExperiment, removeRegistration, getRegisteredExperiments (server version >=2 only): functions helping with registration of experiments, ie. limiting access to the given experiment to yourself. They do what's on their label.

Download

Key download functions are:

  • getUsers: lists the userCodes and the number of records for each user
  • getDestinations (server version >=2 only): lists the destination files available for each experiment
  • downloadExperiment: downloads the results of a destination file for a given experiment into a data frame. This is the main download function.

Others

For further info, see the R documentation!

Copy Link

Version

Install

install.packages('Rexperigen')

Monthly Downloads

204

Version

0.2.1

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Daniel Szeredi

Last Published

August 26th, 2016

Functions in Rexperigen (0.2.1)

getUsers

Requests the table of users from the server.
create.API.request.URL

Create an URL for a request to the Experigen API.
createExperimenter

Create a login for yourself using this function
getDestinations

Returns the list of destination files for an experiment.
downloadExperiment

Makes a download request from the server.
checkAuthentication

Checks whether the authentication is supported by the server and handles the different POST request routes.
API.request

Run a request to the API
cleanURL

Returns the cleaned source URL.
server.version

Returns the version of an Experigen server
setExperigenCredentials

Sets up the experimenter credentials for the further requests. It can also check whether the authentication is successful.
Rexperigen

Rexperigen: an R interface to Experigen
logoutExperigen

Simply removes the stored credentials, so following requests will be unauthenticated.
removeRegistration

Removes the registration of the experiment
setExperigenServer

Sets the Experigen server address for further operations. By default, it checks the existence of the server and sets the Rexperigen.server.version option based on the response of the server. If check = FALSE, set the version by yourself!
registerExperiment

Registers an experiment to the experimenter.
prepare.server.URL

Server URL preparation.
NO_SERVER_ERROR

Error string returned when no server is found
versionMain

Returns the main version number of the server.
getRegisteredExperiments

Get a list of registered experiments.
checkLogin

Checks whether the user is logged in.