configure: Function to configure the behavior of the chronosphere...

View source: R/global.R

configureR Documentation

Function to configure the behavior of the chronosphere package.

Description

This function will allow you to set package variables.

Usage

configure(timeout = NULL, remote = NULL, curl = NULL)

Arguments

timeout

Timeout option used with default R download socket. The global default value for this is 500, which can be increased for very large files and a slow internet connection. Has no effect, when curl=TRUE.

remote

Character string which is the URL of the chronos server.

curl

Logical value of the 'curl' package variable.

Details

The following package-wide variables can be set. timeout: Positive integer. Timeout of connections in seconds when the default R sockets are used. The global setting by default is '300'. #' remote: Character string. URL of the chronosphere repositories, the default value is "https://github.com/chronosphere-info/chrono_arch/raw/main/". curl: Logical value. If set to TRUE (default), the curl libraries are used to download files. If set to FALSE (default) the default R sockets are used, which can result in timeout issues that need to be resolved manually.

Value

The function has no return value.

Examples

configure(curl=FALSE)

chronosphere documentation built on Aug. 17, 2023, 5:08 p.m.