Disk info addin and function

Author: phgrosjean

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: BioDataScience
 Type: Package
-Version: 2023.0.1
+Version: 2023.1.0
 Title: Configuration for Biological Data Science Course
 Description: User sign in and sign out for the Biological Data Science courses
   at the University of Mons, Belgium.

LICENSE

@@ -1,6 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
 export(config)
+export(disk_info)
 export(obfuscator)
 export(sdd_info)
 export(sdd_repo_issue)

LICENSE.md

@@ -1,3 +1,7 @@
+# BioDataScience 2023.1.0
+
+-   An RStudio addin to check disk space used in `/home/jovyan` is added (useful for SaturnCloud). The corresponding function is `disk_info()`, which allows for testing other disks than the one corresponding to `/home/jovyan` (or all disks with `path = ""`).
+
 # BioDataScience 2023.0.1
 
 -   Small correction in `biometrie`: "circomférence du poignet" (typo), but corrected anyway into "tour de poignet", and no unit for "année de la mesure" (idem in `biometry`).

NAMESPACE

@@ -3,6 +3,9 @@
 sdd_repo_issue_addin <- function()
   sdd_repo_issue()
 
+disk_info_addin <- function()
+  disk_info()
+
 sdd_info_addin <- function()
   sdd_info()
 

NEWS.md

@@ -0,0 +1,22 @@
+#' Show disk information
+#'
+#' @description
+#' Calculate disk size total, used and free for a path (or for all disks if
+#' `path = ""`) using the `df` unix command.
+#'
+#' @param path The path to look for.
+#' @param intern If `TRUE`, the output is returned as a character vector,
+#' otherwise the output is directly printed at the console.
+#'
+#' @return With `intern = TRUE`, a character vector with the output of the
+#' command. Otherwise, the function is used for its side effect of printing the
+#' information at the console.
+#'
+#' @export
+#'
+#' @examples
+#' disk_info()
+#' disk_info("")
+disk_info <- function(path = "/home/jovyan", intern = FALSE) {
+  system(paste("df -h", path), intern = intern)
+}