CreateCalendar: Create a calendar from an uploaded CSV.

View source: R/Calendars.R

CreateCalendarR Documentation

Create a calendar from an uploaded CSV.

Description

Create a calendar from an uploaded CSV.

Usage

CreateCalendar(
  dataSource,
  name = NULL,
  multiSeriesIdColumn = NULL,
  maxWait = 600
)

Arguments

dataSource

object. Either (a) the name of a CSV file, or (b) a dataframe. This parameter identifies the source of the calendar data.

name

character. Optional. The name of the calendar.

multiSeriesIdColumn

character. Optional. Added in 2.19. The column in the calendar that defines which series an event belongs to. Only one column is supported.

maxWait

integer. The maximum time (in seconds) to wait for the retrieve to complete.

Value

An S3 object of class "dataRobotCalendar"

Examples

## Not run: 
   CreateCalendar("inst/extdata/calendar.csv", name = "intlHolidayCalendar")

## End(Not run)
## Not run: 
   holidayCalendarDF <- as.data.frame(myCalendar)
   CreateCalendar(holidayCalendarDF, name = "intlHolidayCalendar")

## End(Not run)
## Not run: 
   CreateCalendar("inst/extdata/calendar.csv",
                  name = "intlHolidayCalendar",
                  multiSeriesIdColumn = "Country")

## End(Not run)

datarobot documentation built on May 6, 2022, 5:06 p.m.