Skip to content

Commit

Permalink
docs: lint docs
Browse files Browse the repository at this point in the history
  • Loading branch information
luciorq committed Dec 9, 2024
1 parent 66442d3 commit eb51743
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 14 deletions.
6 changes: 6 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,18 @@

* The base directory path used for creating the environments is now controlled by `tools::R_R_user_dir()` and accepts `R_USER_DATA_DIR`, and `XDG_DATA_HOME`, respectively as environment variables that can control that path. On Unix/Linux it should be `"${HOME}/.local/share/R/condathis"`.

* The default `TMPDIR` for all `run()` and `run_bin()` calls are clean after execution.

## New features

## Minor improvements and fixes

* Improved error message in `list_packages()`when env don't exist (#21).

* Improved message in `install_packages()`.

* Spinner is only active when session is interactive.

# condathis 0.0.7

## New features
Expand Down
4 changes: 2 additions & 2 deletions R/install_packages.R
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
#' packages = "fastqc",
#' env_name = "fastqc-env"
#' )
#' # Install the package `vim` in the `fastqc-env` environment.
#' # Install the package `python` in the `fastqc-env` environment.
#' # It is not recommended to install multiple packages in the same environment,
# # as it defeats the purpose of isolation provided by separate environments.
#' condathis::install_packages(packages = "vim", env_name = "fastqc-env")
#' condathis::install_packages(packages = "python", env_name = "fastqc-env")
#' }
#' @export
install_packages <- function(packages,
Expand Down
6 changes: 2 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,11 @@ Run system command line interface (CLI) tools in a **reproducible** and **isolat

## Get started

<!--
When available, install package from [CRAN](https://cran.r-project.org):
When available, install release version of the package from [CRAN](https://cran.r-project.org):

```{r eval=FALSE}
install.packages("condathis")
```
-->

Install package from [R-Universe](https://luciorq.r-universe.dev/condathis):

Expand Down Expand Up @@ -189,7 +187,7 @@ out <- condathis::run(
env_name = "curl-env" # environment
)
cat(out$stdout)
message(out$stdout)
```

This isolation feature of `{condathis}` allows not only running different versions of the same CLI tools but also different tools that have **incompatible dependencies**. One common example is CLI tools that rely on different versions of Python.
Expand Down
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,12 @@ Run system command line interface (CLI) tools in a **reproducible** and

## Get started

<!--
When available, install package from [CRAN](https://cran.r-project.org):
&#10;
When available, install release version of the package from
[CRAN](https://cran.r-project.org):

``` r
install.packages("condathis")
```
-->

Install package from
[R-Universe](https://luciorq.r-universe.dev/condathis):
Expand Down Expand Up @@ -201,7 +200,7 @@ out <- condathis::run(
env_name = "curl-env" # environment
)

cat(out$stdout)
message(out$stdout)
#> curl 8.10.1 (aarch64-apple-darwin20.0.0) libcurl/8.10.1 OpenSSL/3.4.0 (SecureTransport) zlib/1.3.1 zstd/1.5.6 libssh2/1.11.1 nghttp2/1.64.0
#> Release-Date: 2024-09-18
#> Protocols: dict file ftp ftps gopher gophers http https imap imaps ipfs ipns mqtt pop3 pop3s rtsp scp sftp smb smbs smtp smtps telnet tftp ws wss
Expand Down
2 changes: 1 addition & 1 deletion man/condathis-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/install_packages.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit eb51743

Please sign in to comment.