idf_ping: Ping the Field-Database

View source: R/connect_idaifield.R

idf_pingR Documentation

Ping the Field-Database

Description

This function checks if a connection to the Field Database can be established. It returns a boolean value indicating if the connection was successful or not. Warnings are used to indicate why the connection failed, if so.

Usage

idf_ping(conn)

Arguments

conn

An object that contains the connection settings, as returned by connect_idaifield().

Value

A boolean value indicating if the connection was successful (TRUE) or not (FALSE).

See Also

  • Produce a Connection-Settings list with: connect_idaifield()

  • Find all projects in the database with: idf_projects()

Examples

## Not run: 
# Establish a connection to the Field Database
conn <- connect_idaifield(ping = FALSE)

# Ping the Field Database
idf_ping(conn)

## End(Not run)

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