R/metadata_repg.R

In maibrittbergh/dischanalyst: Analyses Hydrological Data, especially Discharge Data

#' Representative Stations in Germany
#'
#'@description Function is searching in input-metadata for representative stations. Depending on the settings, if mark=T it returns the original metadata and adds a column containing logical values. If one entry in the column is TRUE- the station is representative, FALSE if its not. Or, if mark=F it returns a metadata data.frame only containing the representative stations.
#'
#' @param metadata "matrix" "array" ;  Metadata of grdc_dataset. Can be created by \link[dischanalyst]{metadata_grdc} function.
#' @param mark logical; default=F; if FALSE: Function returns new, metadata data.frame containing representative stations only. If TRUE: function returns same metadata data.frame (of GRDC- Dataset) and adds a new column that identifies whether a station is representative (T) or not (F).
#'
#' @return "matrix". Same arrangement like metadata. Contains representative stations or marks representative stations in original/input metadata.
#' @export
#'
#' @examples
#'\dontrun{metadata_repg(metadata_germany)
#'metadata_germany=metadata_repg(metadata_germany, mark=T)}
#'
#'

metadata_repg=function(metadata, mark=F){

  relstat=c("HOHENSAATEN-FINOW", "DRESDEN", "MAGDEBURG-STROMBRUECKE",
            "RATHENOW UP", "CALBE-GRIZEHNE", "INTSCHEDE",  "HANN.-MUENDEN", "VLOTHO",
            "VERSEN-WEHRDURCHSTICH", "GREVEN", "MAXAU", "KAUB", "KOELN", "COCHEM", "WUERZBURG" , "ROCKENAU SKA", "ACHLEITEN", "BURGHAUSEN", "WASSERBURG", "LANDSBERG", "KEMPTEN")
if(mark==F){
 #relevante Stationen
  l=length(relstat)
  rows=rep(0,l)
  for ( i in 1:l){

    rows[i]=which(metadata$station==relstat[i])
  }



  metadata_repg=metadata[rows,]
  return(metadata_repg)}
  #(von Ost nach West):
  # Ratzdorf / Oder: nicht gefunden  gab es nicht, habe "HOHENSAATEN-FINOW" genommen , oder ist "EISENHUETTENSTADT" besser?
  #Nienburg / Saale  #Nienburg garb es nicht. Habe CALBE-GRIZEHNE genommen
  #Höxter; / Weser #höxter gab es nicht, habe "HANN.-MUENDEN", "VLOTHO" genommen
  #Lingen-Darme / Ems # gab es nicht habe "VERSEN-WEHRDURCHSTICH", "GREVEN" genommen

  #Neu Ulm, Achleiten/ Donau #neu ulm gibts nicht


  if(mark==T){

    l=length(relstat)
    rows=rep(0,l)
    for ( i in 1:l){

      rows[i]=which(metadata$station==relstat[i])
    }



    representative=rep(F,nrow(metadata))
    representative[rows]=T
    metadata$rep_stat=representative
    return(metadata)
  }



}