From ee83f5a3748e384b542a763bd11e1b031e778b96 Mon Sep 17 00:00:00 2001 From: Kyle Barrett Date: Wed, 10 Apr 2024 19:41:47 -0400 Subject: [PATCH] cli-16703-347 --- 404.html | 6 ++-- LICENSE-text.html | 6 ++-- LICENSE.html | 6 ++-- articles/getting-started.html | 46 +++++++++++++++++--------- articles/index.html | 6 ++-- authors.html | 8 ++--- index.html | 8 ++--- news/index.html | 10 +++--- pkgdown.yml | 4 +-- reference/EXAMPLE_PYTHON_DIR.html | 6 ++-- reference/PYTHON_R_ENV.html | 6 ++-- reference/check_py_pkgs_installed.html | 6 ++-- reference/import_main_py.html | 6 ++-- reference/import_py_pkgs.html | 6 ++-- reference/index.html | 6 ++-- reference/miniconda_is_installed.html | 6 ++-- reference/pipe.html | 6 ++-- reference/py_module_available.html | 6 ++-- reference/pythonR_examples.html | 6 ++-- reference/python_is_installed.html | 6 ++-- reference/setup_py_env.html | 6 ++-- reference/shutdown_virtual_env.html | 6 ++-- 22 files changed, 96 insertions(+), 82 deletions(-) diff --git a/404.html b/404.html index 1e0e596..d6105e0 100644 --- a/404.html +++ b/404.html @@ -12,7 +12,7 @@ - + @@ -39,7 +39,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -107,7 +107,7 @@

Page not found (404)

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/LICENSE-text.html b/LICENSE-text.html index 094b35c..3e6f4ab 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -1,5 +1,5 @@ -License • pythonRLicense • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -75,7 +75,7 @@

License

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/LICENSE.html b/LICENSE.html index 17cdf1d..97a6e9d 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -1,5 +1,5 @@ -MIT License • pythonRMIT License • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -79,7 +79,7 @@

MIT License

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/articles/getting-started.html b/articles/getting-started.html index 69610e9..649348c 100644 --- a/articles/getting-started.html +++ b/articles/getting-started.html @@ -12,7 +12,7 @@ - + @@ -40,7 +40,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -105,8 +105,7 @@

Setting up your environment
-
-## With a conda environment (the default) ##
+## With a conda environment (the default) ##
 py_env <- setup_py_env(py_pkgs = c("pandas", "numpy", "scipy"))
 py_env
 
@@ -191,17 +190,32 @@ 

Provided python-based functions# View the functions get("py_add", envir = pythonR_examples) #> expression({ -#> py_add <- function(x = 5, y = 10) { -#> py_script <- file.path(EXAMPLE_PYTHON_DIR, "script-add.py") -#> if (isTRUE(python_is_installed())) { -#> reticulate::source_python(py_script) -#> } -#> sum <- py_add(x, y) -#> return(sum) -#> } -#> }) -# get("py_check_path", envir = pythonR_examples) -# get("py_array", envir = pythonR_examples)

+#> # Simple python function +#> # +#> # @param x a number +#> # @param y a number +#> # +#> # @details +#> # This function does not require imports or virtual environment (much faster) +#> py_add <- function( +#> x = 5, +#> y = 10 +#> ){ +#> +#> # source specific python script +#> py_script <- file.path(EXAMPLE_PYTHON_DIR, 'script-add.py') +#> +#> # Source python script if python is installed +#> if(isTRUE(python_is_installed())){ +#> reticulate::source_python(py_script) +#> } +#> +#> # `py_add` is a function defined in `py_script` +#> sum <- py_add(x, y) +#> +#> return(sum) +#> } +#> })
 # Assign the function to use it
 py_add <- get_py_example("py_add")
@@ -227,7 +241,7 @@ 

Provided python-based functions

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/articles/index.html b/articles/index.html index 723b1aa..bc0e1ef 100644 --- a/articles/index.html +++ b/articles/index.html @@ -1,5 +1,5 @@ -Articles • pythonRArticles • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -72,7 +72,7 @@

All vignettes

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/authors.html b/authors.html index c23aab7..3d3bf99 100644 --- a/authors.html +++ b/authors.html @@ -1,5 +1,5 @@ -Authors and Citation • pythonRAuthors and Citation • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -54,7 +54,7 @@
@@ -93,7 +93,7 @@

Citation

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/index.html b/index.html index 5ca3f30..7da980d 100644 --- a/index.html +++ b/index.html @@ -12,7 +12,7 @@ - + @@ -40,7 +40,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -85,7 +85,7 @@
- @@ -58,9 +58,9 @@

Changelog

- +
-

First official release

+

First official release

Core exported functions:

  • setup_py_env: Set up a python environment with required packages
  • @@ -95,7 +95,7 @@

    First official release
    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.8.

diff --git a/pkgdown.yml b/pkgdown.yml index 57a43e0..8bd3501 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -1,9 +1,9 @@ pandoc: 2.17.1.1 -pkgdown: 2.0.7 +pkgdown: 2.0.8 pkgdown_sha: ~ articles: getting-started: getting-started.html -last_built: 2024-02-13T14:15Z +last_built: 2024-04-10T23:41Z urls: reference: https://barrettk.github.io/pythonR/reference article: https://barrettk.github.io/pythonR/articles diff --git a/reference/EXAMPLE_PYTHON_DIR.html b/reference/EXAMPLE_PYTHON_DIR.html index 2c79a4b..1ec0b6f 100644 --- a/reference/EXAMPLE_PYTHON_DIR.html +++ b/reference/EXAMPLE_PYTHON_DIR.html @@ -1,5 +1,5 @@ -Package directory containing example python scripts — EXAMPLE_PYTHON_DIR • pythonRPackage directory containing example python scripts — EXAMPLE_PYTHON_DIR • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0
@@ -83,7 +83,7 @@

Format

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/reference/PYTHON_R_ENV.html b/reference/PYTHON_R_ENV.html index 9c6a76d..6f07cef 100644 --- a/reference/PYTHON_R_ENV.html +++ b/reference/PYTHON_R_ENV.html @@ -1,5 +1,5 @@ -Default environment name for python packages — PYTHON_R_ENV • pythonRDefault environment name for python packages — PYTHON_R_ENV • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -83,7 +83,7 @@

Format

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/reference/check_py_pkgs_installed.html b/reference/check_py_pkgs_installed.html index e4fbb3d..9743f12 100644 --- a/reference/check_py_pkgs_installed.html +++ b/reference/check_py_pkgs_installed.html @@ -1,5 +1,5 @@ -Helper function for ensuring required python packages are installed — check_py_pkgs_installed • pythonRHelper function for ensuring required python packages are installed — check_py_pkgs_installed • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -93,7 +93,7 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/reference/import_main_py.html b/reference/import_main_py.html index 2314d42..5aacc92 100644 --- a/reference/import_main_py.html +++ b/reference/import_main_py.html @@ -1,5 +1,5 @@ -Import main module and default functions — import_main_py • pythonRImport main module and default functions — import_main_py • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -96,7 +96,7 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/reference/import_py_pkgs.html b/reference/import_py_pkgs.html index 61d791e..aba7d6f 100644 --- a/reference/import_py_pkgs.html +++ b/reference/import_py_pkgs.html @@ -1,5 +1,5 @@ -Import python packages — import_py_pkgs • pythonRImport python packages — import_py_pkgs • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -117,7 +117,7 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/reference/index.html b/reference/index.html index 20df9bd..5eeed4b 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,5 +1,5 @@ -Function reference • pythonRFunction reference • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -105,7 +105,7 @@

Examples

pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/reference/miniconda_is_installed.html b/reference/miniconda_is_installed.html index 4b9ce0e..e933fd3 100644 --- a/reference/miniconda_is_installed.html +++ b/reference/miniconda_is_installed.html @@ -1,5 +1,5 @@ -Check that minicoonda is installed at specified location — miniconda_is_installed • pythonRCheck that minicoonda is installed at specified location — miniconda_is_installed • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -89,7 +89,7 @@

Note

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/reference/pipe.html b/reference/pipe.html index 6fe873b..3439a73 100644 --- a/reference/pipe.html +++ b/reference/pipe.html @@ -1,5 +1,5 @@ -Pipe operator — %>% • pythonRPipe operator — %>% • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -79,7 +79,7 @@

Pipe operator

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/reference/py_module_available.html b/reference/py_module_available.html index 7ab6c5c..21ff7ef 100644 --- a/reference/py_module_available.html +++ b/reference/py_module_available.html @@ -1,5 +1,5 @@ -Modified version of reticulate::py_module_available() — py_module_available • pythonRModified version of reticulate::py_module_available() — py_module_available • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -89,7 +89,7 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/reference/pythonR_examples.html b/reference/pythonR_examples.html index 4334479..d5a067e 100644 --- a/reference/pythonR_examples.html +++ b/reference/pythonR_examples.html @@ -1,5 +1,5 @@ -Retrieve example function from pythonR_examples — get_py_example • pythonRRetrieve example function from pythonR_examples — get_py_example • pythonRCheck that python is installed — python_is_installed • pythonRCheck that python is installed — python_is_installed • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -86,7 +86,7 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/reference/setup_py_env.html b/reference/setup_py_env.html index 001455b..b8c491d 100644 --- a/reference/setup_py_env.html +++ b/reference/setup_py_env.html @@ -1,5 +1,5 @@ -Set up a python environment with required packages — setup_py_env • pythonRSet up a python environment with required packages — setup_py_env • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -225,7 +225,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.

diff --git a/reference/shutdown_virtual_env.html b/reference/shutdown_virtual_env.html index 3ad22ae..9989537 100644 --- a/reference/shutdown_virtual_env.html +++ b/reference/shutdown_virtual_env.html @@ -1,5 +1,5 @@ -Shut down virtual environment — shutdown_virtual_env • pythonRShut down virtual environment — shutdown_virtual_env • pythonR @@ -17,7 +17,7 @@ pythonR - 0.0.1 + 0.1.0 @@ -98,7 +98,7 @@

Details

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.8.