get_configuration: Get the Custom Project Configuration as Stored in the Project...

View source: R/get_configuration.R

get_configurationR Documentation

Get the Custom Project Configuration as Stored in the Project Database

Description

This function retrieves the project configuration (if existent) from an iDAI.field project. The list will only contain fields and valuelists that have been edited in the project configuration editor in iDAI.field 3 (Field Desktop) and does not encompass fields, valuelists and translation added before the update to iDAI.field 3.

Usage

get_configuration(connection, projectname = NULL)

Arguments

connection

A connection object as returned by connect_idaifield()

projectname

(deprecated) The name of the project in the Field Client that one wishes to load. Will overwrite the project argument that was set in connect_idaifield().

Value

A list containing the project configuration; NA if the configuration could not be found or the connection failed.

See Also

  • Get the inputTypes from a Configuration: get_field_inputtypes()

  • This function is used by: simplify_idaifield().

Examples

## Not run: 
conn <- connect_idaifield(serverip = "127.0.0.1",
user = "R", pwd = "hallo", project = "rtest")
config <- get_configuration(connection = conn,
projectname = "rtest")

## End(Not run)

lsteinmann/idaifieldR documentation built on April 3, 2025, 2:06 p.m.