R/plot_ts_data.R

In marcianito/UmbrellaEffect: Gravity data reduction procedure (related to the shielding of its building)

#' @title Plot multiply time series with one same basis
#'
#' @description Plot all gravity time series used and calulated throught this reduction procedure in one joined plot.
#'
#' @param gravity_obs Character string with the filename of the gravity observation data to be used.
#' @param gravity_outside Data.frame, containing gravity response corresponding to mass variations from outside of the buildling.
#' It has 2 columns (datatime and value).
#' @param gravity_below Data.frame, containing gravity response corresponding to mass variations from below of the buildling.
#' It has 2 columns (datatime and value).
#' @param gravity_reduced Data.frame, containing the reduced gravity data (gravity observation data corrected for mass variations from below the SG building).
#' It has 2 columns (datatime and value).
#' @param input_dir Character string, containing the path to input file "gravity_obs".
#' @param output_dir Character string, containing the path to the directory where to save the plot.
#' 
#' @return Returns NULL as object. It creates a plot of all input time series.
#' This plot is shown on screen as well as saved to the specified output folder.
#' 
#' @details missing
#' @references Marvin Reich (2017), mreich@@posteo.de
#' @examples missing

plot_ts_data = function(
            gravity_obs = NA,
            gravity_outside,
            gravity_below,
            gravity_reduced = NA,
            input_dir = dir_input,
            output_dir = dir_output,
            dat_tsf = 7,
            ...
){
    # gravity_obs = gravityObservations_input_file
    # gravity_outside = gravity_response_outside_building
    # gravity_below = gravity_response_below_building
    # gravity_reduced = gravity_data_reduced
    # input_dir = dir_input

    # subtract starting value (of first timestep)
    # this is done to create relative mass change responses and not absolut
    # gravity reponse outside & below
    gravity_outside$value = gravity_outside$value - gravity_outside$value[1]
    gravity_below$value = gravity_below$value - gravity_below$value[1]
    # # subtract mean value 
    # gravity_outside$value = gravity_outside$value - mean(gravity_outside$value, na.rm = T)
    # gravity_below$value = gravity_below$value - mean(gravity_below$value, na.rm = T)

    ## read in routine for gravity obs data
    # same as in function "reduce_gravity"
    # this time resulting in columns $datetime, $value
    if(!is.na(gravity_obs)){
        # read data
        gravity_obs_data = read_data(gravity_obs, input_dir, dat_tsf = dat_tsf)
        # # subtract mean value 
        # gravity_obs_data$value = gravity_obs_data$value - mean(gravity_obs_data$value, na.rm = T)
        # gravity_reduced$value = gravity_reduced$value - mean(gravity_reduced$value, na.rm = T)
        # subtract first value 
        gravity_obs_data$value = gravity_obs_data$value - gravity_obs_data$value[1]
        gravity_reduced$value = gravity_reduced$value - gravity_reduced$value[1]

        # combine datasets
        gravity_data_all = rbind(
                cbind(gravity_obs_data, Source = "Observed"),
                cbind(gravity_outside, Source = "Outside"),
                cbind(gravity_below, Source = "Below"),
                cbind(gravity_reduced, Source = "Reduced")
        )
    }else{
        # combine datasets
        gravity_data_all = rbind(
                cbind(gravity_outside, Source = "Outside"),
                cbind(gravity_below, Source = "Below")
        )
    }

    # plot
    gravity_ts.gg = ggplot(data = gravity_data_all,
                           aes(x = datetime, y = value, colour = Source)) +
                    geom_line() + 
                    ylab("Gravity response [nm/s²]") + 
                    xlab("Time") + 
                    scale_color_manual(values = viridis(length(unique(gravity_data_all$Source)))) + 
                    theme(
                          legend.position = "right"
                          )

    # save plot
    png(filename = paste0(output_dir, "Gravity_timeseries.png"),
                      width = 600,
                      height = 400,
                      res = 150)
    print(gravity_ts.gg)
    dev.off()
    # print on screen
    # plot(gravity_ts.gg)
    # return NULL
    return(gravity_ts.gg)
}