create_series_catalog: Create the SeriesCatalog table

In EDIorg/hymetDP: Tools to Create, Use, and Convert hymetDP data

Create the SeriesCatalog table

Description

Create the SeriesCatalog table

Usage

create_series_catalog(
  L0_flat = NULL,
  Sources = NULL,
  Methods = NULL,
  Variables = NULL,
  Sites = NULL,
  QualityControlLevels = NULL,
  DataValues = NULL
)

Arguments

L0_flat	(tbl_df, tbl, data.frame) The fully joined source L0 dataset, in "flat" format (see details).
Sources	(tbl_df, tbl, data.frame) The Sources table.
Methods	(tbl_df, tbl, data.frame) The Methods table.
Variables	(tbl_df, tbl, data.frame) The Variables table.
Sites	(tbl_df, tbl, data.frame) The Sites table.
QualityControlLevels	(tbl_df, tbl, data.frame) The QualityControlLevels table.
DataValues	(tbl_df, tbl, data.frame) The DataValues table.

Details

This function appends columns to the L0_flat table and returns the augmented table.

"flat" format refers to the fully joined source L0 dataset in "wide" form with the exception of the core observation variables, which are in "long" form (i.e. using the variable_name, value, unit columns of the observation table). This "flat" format is the "widest" an L1 hymetDP dataset can be consistently spread due to the frequent occurrence of L0 source datasets with > 1 core observation variable.

Value

(tbl_df, tbl, data.frame) The SeriesCatalog table.

See Also

Other create required tables: create_data_values(), create_methods(), create_quality_control(), create_sites(), create_sources(), create_variables()

Examples

flat <- hymet_L0_flat

Sources <- hymetDP::create_sources(
  L0_flat = flat,
  SourceCode = "SourceCode",
  Organization = "Organization",
  SourceDescription = "SourceDescription",
  SourceLink = "SourceLink",
  ContactName = "ContactName",
  Phone = "Phone",
  Email = "Email",
  Address = "Address",
  City = "City",
  State = "State",
  ZipCode = "ZipCode",
  Citation = "Citation")

Methods <- hymetDP::create_methods(
  L0_flat = flat,
  MethodCode = "MethodCode",
  MethodDescription = "MethodDescription")

Variables <- hymetDP::create_variables(
  L0_flat = flat,
  VariableCode = "VariableCode",
  VariableName = "VariableName",
  VariableUnitsName = "VariableUnitsName",
  SampleMedium = "SampleMedium",
  ValueType = "ValueType",
  IsRegular = "IsRegular",
  TimeSupport = "TimeSupport",
  TimeUnitsName = "TimeUnitsName",
  DataType = "DataType",
  GeneralCategory = "GeneralCategory",
  NoDataValue = "NoDataValue")

Sites <- hymetDP::create_sites(
  L0_flat = flat,
  SiteCode = "SiteCode",
  SiteName = "SiteName",
  Latitude = "Latitude",
  Longitude = "Longitude",
  LatLongDatumSRSName = NULL,
  Elevation_m = NULL,
  VerticalDatum = NULL,
  LocalX = NULL,
  LocalY = NULL,
  LocalProjectionSRSName = NULL,
  PosAccuracy_m = NULL,
  State = NULL,
  County = NULL,
  Comments = NULL,
  SiteType = "SiteType")

QualityControlLevels <- hymetDP::create_quality_control(
  L0_flat = flat,
  QualityControlLevelCode = "QualityControlLevelCode",
  Definition = "Definition",
  Explanation = "Explanation")

DataValues <- hymetDP::create_data_values(
  L0_flat = flat,
  ValueID = "ValueID",
  DataValue = "DataValue",
  ValueAccuracy = NULL,
  LocalDateTime = "LocalDateTime",
  UTCOffset = "UTCOffset",
  DateTimeUTC = "DateTimeUTC",
  SiteCode = "SiteCode",
  VariableCode = "VariableCode",
  OffsetValue = NULL,
  OffsetTypeCode = NULL,
  CensorCode = NULL,
  QualifierCode = NULL,
  MethodCode = "MethodCode",
  QualityControlLevelCode = "QualityControlLevelCode",
  SourceCode = "SourceCode",
  NoDataValue = "NoDataValue")

SeriesCatalog <- hymetDP::create_series_catalog(
  Sources = Sources,
  Methods = Methods,
  Variables = Variables,
  Sites = Sites,
  QualityControlLevels = QualityControlLevels,
  DataValues = DataValues)

SeriesCatalog

EDIorg/hymetDP documentation built on Nov. 18, 2022, 5:28 p.m.