init github pages pkgdown, pkgdown fixes

Author: idmn

.Rbuildignore

@@ -3,3 +3,6 @@
 ^LICENSE\.md$
 ^sandbox$
 ^\.github$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$

.github/workflows/pkgdown.yaml

@@ -0,0 +1,48 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/[email protected]
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -2,3 +2,4 @@
 .Rhistory
 .RData
 .Ruserdata
+docs

DESCRIPTION

@@ -2,12 +2,11 @@ Package: cloudfs
 Title: Streamlined interface to interact with cloud storage platforms
 Version: 0.0.1
 Authors@R: c(
-    person("Tom", "Vladeck", email = "[email protected] ", role  = c("aut")),
-    person("Stefan", "Musch", email = "[email protected]", role = c("aut")),
     person("Iaroslav", "Domin", email = "[email protected]", role = c("aut", "cre")),
+    person("Stefan", "Musch", email = "[email protected]", role = c("aut")),
     person("Michal", "Czyz", email = "[email protected]", role = c("aut")),
     person("Emmanuel", "Ugochukwu", email = "[email protected]", role = c("aut")),
-    person("Gradient Metrics", role = c("cph"))
+    person("Gradient Metrics", role = c("cph", "fnd"))
   )
 Description: This package offers a unified interface for simplifying cloud 
     storage interactions, including uploading, downloading, reading, and writing 
@@ -40,3 +39,4 @@ Suggests:
 VignetteBuilder: 
     knitr
 Config/testthat/edition: 3
+URL: https://g6t.github.io/cloudfs/, https://github.com/g6t/cloudfs

NAMESPACE

@@ -1,6 +1,5 @@
 # Generated by roxygen2: do not edit by hand
 
-export(check_bool)
 export(cloud_drive_attach)
 export(cloud_drive_browse)
 export(cloud_drive_download)

R/cli.R

@@ -29,7 +29,7 @@
 #' cli_yeah("{.field Yes} or {.field No}?", straight = TRUE)
 #' }
 #' 
-#' @noRd 
+#' @keywords internal
 cli_yeah <- function(x, straight = FALSE, .envir = parent.frame()) {
   check_scalar(x, arg_class = "character")
   check_scalar(straight, arg_class = "logical")
@@ -103,7 +103,7 @@ cli_yeah <- function(x, straight = FALSE, .envir = parent.frame()) {
 #' check_scalar(num_s, arg_class = "integer")
 #' check_scalar(logical_v, arg_class = "integer", alt_null = TRUE)
 #' }
-#' @noRd 
+#' @keywords internal 
 check_scalar <- function(..., arg_class, alt_null = FALSE) {
 
   .args <- check_args(...)
@@ -191,7 +191,7 @@ check_numeric <- function(x) {
 #' check_class(nl1, arg_class = "character", alt_null = TRUE)
 #' check_class(n2, arg_class = "character", alt_null = TRUE)
 #' }
-#' @noRd 
+#' @keywords internal
 check_class <- function(x, arg_class, alt_null = FALSE, add_msg = NULL) {
   if(!(inherits(arg_class, "character") & length(arg_class) == 1)) {
     cli::cli_abort(
@@ -264,7 +264,7 @@ check_class <- function(x, arg_class, alt_null = FALSE, add_msg = NULL) {
 #'   nl1, arg_length = 2L, alt_null = TRUE, add_msg = "{.arg {x_name}} should be short"
 #' )
 #' }
-#' @noRd 
+#' @keywords internal
 check_length <- function(x, arg_length = 1L, alt_null = FALSE, add_msg = NULL) {
   if(!inherits(arg_length, "integer") | length(arg_length) != 1) {
     cli::cli_abort(
@@ -303,7 +303,7 @@ check_length <- function(x, arg_length = 1L, alt_null = FALSE, add_msg = NULL) {
 #' 
 #' @param ... unqouted arguments names
 #' 
-#' @noRd 
+#' @keywords internal
 check_args <- function(...) {
   rlang::quos(...)
 }
@@ -317,7 +317,7 @@ check_args <- function(...) {
 #' @param x Argument to check if is NULL.
 #' @param alt_null Logical. If `TRUE` it will check if `x` is `NULL`.
 #' 
-#' @noRd 
+#' @keywords internal
 check_null_cond <- function(x, alt_null){
   if(!(isTRUE(alt_null) | isFALSE(alt_null) | length(alt_null) != 1)) {
     cli::cli_abort(
@@ -367,7 +367,7 @@ check_null_cond <- function(x, alt_null){
 #' check_bool(l1)
 #' check_bool(l2)
 #' }
-#' @export
+#' @keywords internal
 check_bool <- function(x, alt_null = FALSE, add_msg = NULL) {
 
   check_class(add_msg, arg_class = "character", alt_null = TRUE)

R/cloud_local.R

@@ -172,7 +172,8 @@ cloud_object_ls <- function(x, path, extension, prefix = "", suffix = "") {
 #' @param content (data.frame) output of `cloud_object_ls()`
 #' @param quiet all caution messages may be turned off by setting this parameter
 #'   to `TRUE`.
-#'   
+#'
+#' @keywords internal
 cloud_object_prep_bulk <- function(content, quiet = FALSE) {
   check_class(content, "data.frame")
   stopifnot(all(c("object", "name", "type") %in% names(content)))

R/common.R

@@ -19,6 +19,7 @@ cloud_get_roots <- function(project = ".") {
 #' @inheritParams validate_desc
 #' @param key Character. What field to search for in DESCRIPTION file.
 #' 
+#' @keywords internal
 proj_desc_get <- function(key, project = ".") {
   check_string(key)
   check_string(project)
@@ -37,7 +38,8 @@ proj_desc_get <- function(key, project = ".") {
 #'   letters, digits, '-', '_', '.', spaces and '/' symbols.
 #' @param error if `TRUE` (default), throws an error if `file` is not a valid 
 #'   file path.
-#'   
+#'
+#' @keywords internal
 cloud_validate_file_path <- function(file, error = TRUE) {
   check_string(file)
   res <- grepl("^([A-Za-z]|[0-9]|-|_|\\.| |/)+$", file)
@@ -149,6 +151,7 @@ validate_desc <- function(project = ".") {
 #' @param full_names (logical) If `TRUE`, folder path is appended to object
 #'   names to give a relative file path.
 #' 
+#' @keywords internal
 cloud_prep_ls <- function(data, path, recursive, full_names) {
   check_class(data, arg_class = "data.frame")
   required_cols <- c("short_name", "last_modified", "size_b")

R/drive_setup.R

@@ -127,7 +127,8 @@ cloud_drive_get_root <- function(project = ".") {
 #' \dontrun{
 #' cloud_drive_find_path("1ul0MYeHb0nJtnuaPinKV1WtH0n3igmN2", "models/kmeans")
 #' }
-#' 
+#'
+#' @keywords internal
 cloud_drive_find_path <- function(root, path = "", create = FALSE) {
   check_string(path)
   check_string(root)

R/drive_transfer_bulk.R

@@ -20,6 +20,7 @@
 #' @param quiet All caution messages may be turned off by setting this parameter
 #'   to `TRUE`.
 #'   
+#' @keywords internal
 cloud_drive_prep_bulk <- function(content, what = c("read", "download"),
                                safe_size = 5e7, quiet = FALSE) {
   check_class(content, "data.frame")