Use life cycle mark badges

#53

R/files_manager.R

@@ -34,11 +34,11 @@
 #'   upload together with the other file. PDF are directly uploaded, HTML can be
 #'   first converted into PDF if package `pagedown` and Chrome are
 #'   available.
-#' @param rich_text (experimental) logical value (default is `TRUE`)
+#' @param rich_text `r lifecycle::badge("experimental")` logical value (default is `TRUE`)
 #'   indicating whether to upload to Google Docs a rich document (i.e.,
 #'   important text that should not be changed is highlighted). See “Rich Text”
 #'   in details section.
-#' @param rich_text_par (experimental) argument used to pass a list with custom
+#' @param rich_text_par `r lifecycle::badge("experimental")` argument used to pass a list with custom
 #'   settings for rich_text. See “Rich Text” in details section.
 #' @param force logical value indicating whether to skip confirm check by user
 #'   (default is `FALSE`).
@@ -49,7 +49,7 @@
 #'
 #' @details
 #'
-#' **Rich Text (experimental)**
+#' **Rich Text `r lifecycle::badge("experimental")`**
 #'
 #' The `rich_text` option (default is `TRUE`) allows to upload a rich
 #' document to Google Docs. Important text that should not be changed is
@@ -299,7 +299,7 @@ update_file <- function(file,
 #' [trackdown-package()] help page.
 #'
 #' @inheritParams upload_file
-#' @param rm_gcomments (experimental) logical value indicating whether or not to
+#' @param rm_gcomments `r lifecycle::badge("experimental")` logical value indicating whether or not to
 #'   remove Google comments.
 #'
 #' @return `TRUE` if file from Google Drive was saved, `FALSE` otherwise.
@@ -408,7 +408,7 @@ download_file <- function(file,
 #' [trackdown-package()] help page.
 #' 
 #' @inheritParams upload_file
-#' @param rm_gcomments (experimental) logical value indicating whether or not to
+#' @param rm_gcomments `r lifecycle::badge("experimental")` logical value indicating whether or not to
 #'   remove Google comments.
 #' @return `TRUE` if file from Google Drive was saved and rendered, `FALSE`
 #'   otherwise.

README.Rmd

@@ -34,8 +34,8 @@ The `trackdown` package offers a simple solution for collaborative writing and e
 
 > From `trackdown` v1.3.0 [currently only available on GitHub], the `trackdown` package introduces the `rich_text` feature and uses its own API credentials.
 > 
-> - **`rich_text`.** Upload *rich* documents to Google Docs where important text that should not be changed is automatically highlighted (e.g., placeholders hiding the code, header of the document, code chunks, and in-line code). This prevents collaborators from inadvertently making changes to the code which might corrupt the file. See [rich-text feature details]( https://claudiozandonella.github.io/trackdown/articles/trackdown-features.html#rich-text).
-> - **API Credentials.** Now, `trackdown` uses its own Google API credentials (OAuth client ID and secret). This requires Google authentication and to enable *“Trackdown R Package”*. The project is undergoing Google verification so it is already available but Google displays a warning message (see details at [issue comment](https://github.com/ClaudioZandonella/trackdown/issues/28#issuecomment-1057195007)). Don't worry `trackdown` uses the same system as the `googledrive` package that was previously used. See details on privacy policy at `vignette("trackdown-privacy-policy")`).
+> - **`rich_text` ![experimental](man/figures/lifecycle-experimental.svg){style="vertical-align:middle"}** - Upload *rich* documents to Google Docs where important text that should not be changed is automatically highlighted (e.g., placeholders hiding the code, header of the document, code chunks, and in-line code). This prevents collaborators from inadvertently making changes to the code which might corrupt the file. See [rich-text feature details]( https://claudiozandonella.github.io/trackdown/articles/trackdown-features.html#rich-text).
+> - **API Credentials** - Now, `trackdown` uses its own Google API credentials (OAuth client ID and secret). This requires Google authentication and to enable *“Trackdown R Package”*. The project is undergoing Google verification so it is already available but Google displays a warning message (see details at [issue comment](https://github.com/ClaudioZandonella/trackdown/issues/28#issuecomment-1057195007)). Don't worry `trackdown` uses the same system as the `googledrive` package that was previously used. See details on privacy policy at `vignette("trackdown-privacy-policy")`).
 > - [**IMPORTANT**] We currently reached the maximum number of users for the API credentails. Installing the development `trackdown` from GitHub will require to create your own API credentials. Please, see instructions at https://claudiozandonella.github.io/trackdown/articles/oauth-client-configuration.html
 > - **Quarto** documents now supported!!
 
@@ -107,7 +107,7 @@ add_video()
 `trackdown` offers additional features to facilitate the collaborative writing and editing of documents in Google Docs. In particular, it is possible to:
 
 - **Hide Code:** Code in the header of the document (YAML header or LaTeX preamble) and code chunks are removed from the document when uploading to Google Drive and are automatically restored during download. This prevents collaborators from inadvertently making changes to the code which might corrupt the file and allows them to focus on the narrative text.
-- **Rich Text:** Upload *rich* documents to Google Docs. Important text that should not be changed is automatically highlighted (e.g., placeholders hiding the code, header of the document, code chunks, and in-line code). This prevents collaborators from inadvertently making changes to the code which might corrupt the file. 
+- **Rich Text ![experimental](man/figures/lifecycle-experimental.svg){style="vertical-align:middle"}:** Upload *rich* documents to Google Docs. Important text that should not be changed is automatically highlighted (e.g., placeholders hiding the code, header of the document, code chunks, and in-line code). This prevents collaborators from inadvertently making changes to the code which might corrupt the file. 
 - **Upload Output:** The actual output document (i.e., the rendered file) can be uploaded to Google Drive in conjunction with the `.Rmd` (or Quarto / `.Rnw`) document. This helps collaborators to evaluate the overall layout including figures and tables and allows them to add comments to suggest and discuss changes.
 - **Use Google Drive shared drives:** The documents can be uploaded to either a personal Google Drive or to a shared drive to facilitate collaboration.
 

README.md

@@ -30,14 +30,15 @@ locally.
 > `trackdown` package introduces the `rich_text` feature and uses its
 > own API credentials.
 >
-> - **`rich_text`.** Upload *rich* documents to Google Docs where
->   important text that should not be changed is automatically
->   highlighted (e.g., placeholders hiding the code, header of the
->   document, code chunks, and in-line code). This prevents
->   collaborators from inadvertently making changes to the code which
->   might corrupt the file. See [rich-text feature
+> - **`rich_text` <img src="man/figures/lifecycle-experimental.svg"
+>   style="vertical-align:middle" alt="experimental" />** - Upload
+>   *rich* documents to Google Docs where important text that should not
+>   be changed is automatically highlighted (e.g., placeholders hiding
+>   the code, header of the document, code chunks, and in-line code).
+>   This prevents collaborators from inadvertently making changes to the
+>   code which might corrupt the file. See [rich-text feature
 >   details](https://claudiozandonella.github.io/trackdown/articles/trackdown-features.html#rich-text).
-> - **API Credentials.** Now, `trackdown` uses its own Google API
+> - **API Credentials** - Now, `trackdown` uses its own Google API
 >   credentials (OAuth client ID and secret). This requires Google
 >   authentication and to enable *“Trackdown R Package”*. The project is
 >   undergoing Google verification so it is already available but Google
@@ -128,11 +129,13 @@ possible to:
   download. This prevents collaborators from inadvertently making
   changes to the code which might corrupt the file and allows them to
   focus on the narrative text.
-- **Rich Text:** Upload *rich* documents to Google Docs. Important text
-  that should not be changed is automatically highlighted (e.g.,
-  placeholders hiding the code, header of the document, code chunks, and
-  in-line code). This prevents collaborators from inadvertently making
-  changes to the code which might corrupt the file.
+- **Rich Text <img src="man/figures/lifecycle-experimental.svg"
+  style="vertical-align:middle" alt="experimental" />:** Upload *rich*
+  documents to Google Docs. Important text that should not be changed is
+  automatically highlighted (e.g., placeholders hiding the code, header
+  of the document, code chunks, and in-line code). This prevents
+  collaborators from inadvertently making changes to the code which
+  might corrupt the file.
 - **Upload Output:** The actual output document (i.e., the rendered
   file) can be uploaded to Google Drive in conjunction with the `.Rmd`
   (or Quarto / `.Rnw`) document. This helps collaborators to evaluate