conv2indicatordata: Plotting indicator time series

View source: R/conv2indicatordata.R

conv2indicatordataR Documentation

Plotting indicator time series

Description

This function is for converting deprecated .csv files into an object of class 'indicatordata'.

Usage

conv2indicatordata(
  filename,
  labrows = 1,
  datecols = 1,
  indcols = 2,
  ulimcols = NA,
  llimcols = NA,
  default = F
)

Arguments

filename

a .csv file with indicator names in the initial rows of the file, and dates and indicator values in columns below. For default settings, see details below.

labrows

a vector indicating the rows at the top of the file containing label information. Typically there are three rows with the indicator name, measurement unit, and sublabel.

datecols

an integer which represents the column with the vector of dates.

indcols

an integer of vector indicating which columns of the file contain the indicator values.

ulimcols

an integer of vector indicating which columns of the file contain the upper limits of the confidence intervals, if display is desired.

llimcols

an integer of vector indicating which columns of the file contain the lower limits of the confidence intervals, if display is desired.

default

a logical value indicating whether the .csv file is in default format, in which case the other options do not need to

The "default" version of the .csv file should be formatted as follows:

  • Row 1 contains a character string of the indicator name (main title of plot).

  • Row 2 contains a character string of the indicator units (y-axis label).

  • Row 3 contains an optional character string with information on the sublabel (when multiple panels are used).

  • Column 1 is time values, columns 2 and on are indicator data. The first three values of column 1 are NA.

  • Time can be in year (with century), or monthly time step in a variety of formats (e.g, Jan1986, Jan-86, 1986jan), including or excluding day of month.


mandykarnauskas/plotTimeSeries documentation built on Nov. 21, 2024, 12:34 p.m.