Remove safe_get (#25)

* Remove safe_get * pre-commit autofixes * Remove corresponding tests * roxygenize * Fix pre-commit --------- Co-authored-by: grst <[email protected]>
Boehringer-Ingelheim · Jan 13, 2025 · 15dd6a4 · 15dd6a4
1 parent b1a3879
commit 15dd6a4
Show file tree

Hide file tree

Showing 7 changed files with 6 additions and 279 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v0.7
+
+### Backwards-incompatible changes
+
+-   Remove `safe_get`, because the `dsoParams` class already checks for existance of keys
+
 ## v0.6
 
 ### New Features

diff --git a/NAMESPACE b/NAMESPACE
@@ -12,7 +12,6 @@ export(init)
 export(read_params)
 export(reload)
 export(repro)
-export(safe_get)
 export(set_stage)
 export(stage_here)
 exportClasses(dsoParams)
@@ -22,9 +21,5 @@ importFrom(glue,glue)
 importFrom(here,here)
 importFrom(here,i_am)
 importFrom(methods,show)
-importFrom(rlang,caller_env)
 importFrom(rstudioapi,viewer)
-importFrom(stringr,coll)
-importFrom(stringr,str_match_all)
-importFrom(stringr,str_replace)
 importFrom(yaml,read_yaml)
diff --git a/R/safe_get.R b/R/safe_get.R
diff --git a/README.md b/README.md
@@ -5,7 +5,6 @@ The purpose of this package is to provide access to files and configuration orga
 -   `read_params(stage_path)` loads the configuration for the specified stage into an `dsoParams` R object which can be accessed like a list. The stage name must be relative to the project root. This function works independent of the current working directory, as long as you are in any subdirectory of the project.
 -   `reload(object)` reloads the config loaded by read_params. Usage: `reload(params)`
 -   `stage_here(rel_path)` is inspired by [here()](https://here.r-lib.org/). While `here()` resolves paths that are relative to the project root `stage_here()` resolves paths that are relative to the stage specified in `read_params`.
--   `safe_get()` is a helper function assuring that a nested list call does not return NULL if accessed incorrectly. ' safe_get() will produce an error and point to the incorrectly accessed slot.
 
 Additionally, `dso-r` provides an R interface to some of the most important CLI commands of `dso`.
 

diff --git a/man/dot-convert_list_call_to_dollar_format.Rd b/man/dot-convert_list_call_to_dollar_format.Rd
diff --git a/man/safe_get.Rd b/man/safe_get.Rd
diff --git a/tests/testthat/test-safe_get.R b/tests/testthat/test-safe_get.R