Commit 32ee30e9 authored by Jonathan Mang's avatar Jonathan Mang 💡
Browse files

feat: added "get_db_systems" and "get_current_timestamp" functions

parent d0a82da3
Pipeline #20645 passed with stages
in 18 minutes and 45 seconds
Package: DIZutils
Title: Utilities for 'DIZ' R Package Development
Version: 0.0.6
Date: 2020-11-17
Version: 0.0.6.9002
Date: 2020-12-08
Authors@R:
c(person(given = "Jonathan M.",
family = "Mang",
......
......@@ -9,6 +9,8 @@ export(feedback)
export(firstup)
export(get_config)
export(get_config_env)
export(get_current_timestamp)
export(get_db_systems)
export(global_env_hack)
export(query_database)
export(set_env_vars)
#' @title Quickly get all currently implemented database systems
#'
#' @description Function to quickly get the currently implemented database
#' systems
#'
#' @return The currently implemented database systems as string array.
#' `E.g. c("postgres", "oracle")`
#'#'
#' @examples
#' get_db_systems()
#' # Result: c("postgres", "oracle")
#'
#' @export
#'
get_db_systems <- function() {
return(c("postgres", "oracle"))
}
......@@ -34,7 +34,7 @@ my_desc$set_authors(c(
my_desc$del("Maintainer")
# Set the version
my_desc$set_version("0.0.6")
my_desc$set_version("0.0.6.9002")
# The title of your package
my_desc$set(Title = "Utilities for 'DIZ' R Package Development")
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/get_current_timestamp.R
\name{get_current_timestamp}
\alias{get_current_timestamp}
\title{Quickly get the current timestamp}
\usage{
get_current_timestamp(no_spaces = FALSE)
}
\arguments{
\item{no_spaces}{Boolean. Default = `FALSE`. Specifies wether the output
can contain spaces or not. E.g. if the output is for human reading,
`no_spaces = FALSE` is a good option. As suffix for filenames
(e.g. logfiles), `no_spaces = TRUE` might be a good option.}
}
\value{
The current timestamp in always the same format.
#'
}
\description{
Function to quickly get the current timestamp without
need to handle format-options etc.
}
\examples{
get_current_timestamp(no_spaces = TRUE)
# Result: "2020-12-03-134354"
get_current_timestamp() or get_current_timestamp(no_spaces = FALSE)
# Result: "03.12.2020 - 13:43 UTC"
}
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/get_db_systems.R
\name{get_db_systems}
\alias{get_db_systems}
\title{Quickly get all currently implemented database systems}
\usage{
get_db_systems()
}
\value{
The currently implemented database systems as string array.
`E.g. c("postgres", "oracle")`
#'
}
\description{
Function to quickly get the currently implemented database
systems
}
\examples{
get_db_systems()
# Result: c("postgres", "oracle")
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment