writeProductData: Write data product output

View source: R/saveData.R

writeProductDataR Documentation

Write data product output

Description

This function will output a file that is used for dissemination of the data products produced for the research document.

Usage

writeProductData(
  filename,
  destdir = ".",
  dateCreated = presentTime(),
  contactName,
  contactEMail,
  description = NULL,
  otherMetadata = NULL,
  data,
  ndigits = 1
)

Arguments

filename

a character string indicating the name of the file.

destdir

Optional string indicating the directory in which to store downloaded files. If not supplied, "." is used, i.e. the data file is stored in the present working directory.

dateCreated

a POSIX format date indicating the time of creation, the default is set using the presentTime.

contactName

a character string indicating the person of contact

contactEMail

a character string indicating the contact name's e-mail address.

description

an optional character string providing some details of the data product.

otherMetadata

an optional list indicating additional metadata to provide in the header of the file. The list names should be provided in camelCase.

data

a data.frame of the data that is to be put into the file with appropriate column names, again, prefferably in camelCase

ndigits

the number of digits to output the data, default is 2

Author(s)

Chantelle Layton


clayton33/csasMarPhys documentation built on June 8, 2025, 3:10 a.m.