schoolYear: School Year

Description Usage Arguments Value Examples

View source: R/schoolYear.R

Description

Determine the current school year

Usage

1
schoolYear(x = "year", y = Sys.Date())

Arguments

x

type of information to be returned, defaults to "year". Other acceptable values include termID, start, end, brief, and full

y

date, defaults to the current system date

Value

If y is year or termid, an integer is returned. If y is start or end, a date is returned. If y is brief or full, a character string is returned.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
schoolYear()
schoolYear("TermID")
schoolYear(y = as.Date("2015-09-13"))
schoolYear(x = "TermID", y = as.Date("2015-02-13"))
schoolYear(x = "end")
schoolYear("end", as.Date("2015-09-13"))
schoolYear("end", as.Date("2015-02-13"))
schoolYear(x = "start")
schoolYear("start", as.Date("2015-09-13"))
schoolYear("start", as.Date("2015-02-13"))
schoolYear("full")
schoolYear("brief")

debarros/dbTools documentation built on Sept. 18, 2020, 10:51 a.m.