filenames: Filename Extraction and Creation

Description Usage Arguments Value

View source: R/filenames.R

Description

Function to return total number of cells in objects such as vectors, matrices, dataframes, or lists. dataName, HUC, timestep, and startDate can be lists as long as matching lengths. If any filenames supplied, other inputs ignored.

Usage

1
2
3
filenames(fnames = NULL, dataName = NULL, HUC = NULL, timeStep = NULL,
  startDate = NULL, infoReturn = c("dataName", "HUC", "timeStep",
  "startDate"), returnList = FALSE)

Arguments

fnames

Character; List of filenames of feather files from which to extract data name, HUC number, timestep, and starting date.

dataName

Character; Name of dataset.

HUC

Character or numeric; Number of HUC unit of dataset.

timeStep

Character; Time step between measurements. Can be 'day', 'week', 'month', 'year', etc.

startDate

Character; Starting date for measurements in 'YYYY-M-D' format. Set 'D' to 1 for time steps > weekly.

infoReturn

Character; Data to return when extracting from filenames. List of objects 'dataName', 'HUC', 'timeStep', and 'startDate'. Defaults to returning all data.

returnList

Logical; Option whether to return data in list format or not. Defaults to FALSE, not returning a list.

Value

Number of cells in object.


ssaxe-usgs/METsteps documentation built on May 5, 2019, 5:54 p.m.