download_series: Download Series from Server

Description Usage Arguments

View source: R/functions_treenet.R

Description

download_series downloads specified series from TreeNet or Decentlab server

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
download_series(
  meta_series,
  data_format,
  data_version = NULL,
  from,
  to,
  last,
  bind_df,
  reso,
  path_cred,
  server,
  temp_ref,
  tz,
  use_intl
)

Arguments

meta_series

data.frame, contains the names of the series to download including the reference temperature dataset for each series.

data_format

character, select processing level of data. Can either be "L0" (i.e. raw data), "L1" (i.e time-aligned) or "L2" (i.e. processed).

data_version

character, optional argument specifying the package version number. If provided, L2 data generated by the package version specified is downloaded from the server (download of L0 or L1 data is not affected).

from

character, optional argument to select data after a specific date ("YYYY-MM-DD").

to

character, optional argument to select data up to a specific date ("YYYY-MM-DD").

last

numeric, optional argument to specify the number of latest values. If last is specified from and to need to be empty.

bind_df

logical, indicate whether data should be returned as a data.frame (bind_df = TRUE) or as a named list bind_df = FALSE.

reso

numeric, desired output time resolution (in minutes). See Details for more information on data aggregation.

path_cred

optional argument to specify the full path to the file config.yml containing the database login data. File can also be copied to the main folder of the package for automatic recognition.

server

character, specify server from which data is downloaded. Can be either treenet or decentlab.

temp_ref

logical, specify whether the reference temperature dataset(s) should be downloaded along with specified data.

tz

specify the desired time zone. Default is "UTC".

use_intl

logical, specify whether this function is used internally on the server. Changes stop() error messages to message() only.


treenet/treenetproc documentation built on June 16, 2021, 4:39 p.m.