getAllTimeOptions: generate all possible time options from eligible time points...

Description Usage Arguments Details Value Examples

View source: R/timePointGeneration.R

Description

generate all possible time options from eligible time points and number of samples per time interval ( time zone )

Usage

1
getAllTimeOptions(timeZones, fullTimePoints)

Arguments

timeZones

a data.frame containing information on the number of points to be chosen in each time zone. Each row is a time zone.

  • startTime the start time of each time zone assumed to be included in that zone

  • endTime the end time of the zone. It is not part of the current zone but the start time of the next zone

  • nPointsPerZone the number of time points to be chosen within each zone.

fullTimePoints

a numeric vector containing all possible time points to be considered including time point zero and the last time point

Details

time point zero is never included in any time option and the last time point is always included. Note that the last time point is not a member of any zone. The number of time points in every time options is therefore the total number of time points specified in timeZone plus 1 for the last time point.

Value

SetOfTimePoints-class

Examples

1
2
3
4
5
6
7
8
9
  timeZonesEx              <-  getExampleTimeZones()
  fullTimePointsEx         <-  seq( 0 , 21 , 1 )
  print(timeZonesEx)
  setOfTimePoints          <-  getAllTimeOptions( timeZones = timeZonesEx , 
     fullTimePoints = fullTimePointsEx )
  setOfTimePoints          <-  getAllTimeOptions( 
    timeZones = data.frame(startTime = 0 , endTime = 21 , nPointsPerZone = 1) , 
    fullTimePoints = fullTimePointsEx 
   )

microsamplingDesign documentation built on Oct. 13, 2021, 5:10 p.m.