collection_period: Get the earliest and latest of your data

Description Usage Arguments Value Examples

View source: R/collection_period.R

Description

The function finds the earliest and the latest submission dates in a data frame. It accounts for different spellings of the submission date column by applying a case-insensitive RegEx formula that matches every combination of the words 'submission' and 'date'. Please note, that one and only one of the three data arguments (df, csv, svc) must be specified.

Usage

1
collection_period(df = NULL, csv = NULL, svc = FALSE, date_col)

Arguments

df

Data frame containing the ODK data that is to be used. Optional, defaults to NULL.

csv

Character that specifies the path to the csv file that is to be read. Optional, defaults to NULL.

svc

Logical that indicates whether the data shall be parsed using ruODK's odata_submission_get. Optional, defaults to FALSE.

date_col

String that specifies the date or time stamp column in the data which is to be examined.

Value

list

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 
# 1. with SVC
# ruODK needs to be set up for this function to work
repvisforODK::setup_ruODK(svc = 'example/svc.svc', un = 'exampleusername', pw = 'examplepassword', tz = 'Europe/Berlin', verbose = TRUE)

collection_period(svc = TRUE, date_col = 'start')

# 2. with data frame
collection_period(df = df_odk_data, date_col = 'start')

# 3. with csv
collection_period(csv = 'example/file/odk_data.csv', date_col = 'start')

## End(Not run)

lucidviews/repvisForODK documentation built on Feb. 13, 2022, 9:50 p.m.