From a9e405de56500433ac263c7377f30ac0dbafe061 Mon Sep 17 00:00:00 2001 From: Rani Powers Date: Mon, 22 Jan 2024 11:50:14 -0500 Subject: [PATCH] Add .Renviron.encrypted with instructions --- .Renviron.encrypted | 17 +++++++++++++++++ README.md | 30 ++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 .Renviron.encrypted diff --git a/.Renviron.encrypted b/.Renviron.encrypted new file mode 100644 index 0000000..b011f91 --- /dev/null +++ b/.Renviron.encrypted @@ -0,0 +1,17 @@ +U2FsdGVkX1+jD7VLDrtEUZ9axLc12ryuzJTIAaROie0Q8UoemL03aPxF2B4WXtyx +2QM2bebMPHDjjDrc9cs43dv9zZVhegJwTNp1fkbaK9tN9JbuyVmfdgUlZMtDUDtV +7NYrI8oPNHNxuUUYpvWnxHXwc8Xh3nnhHyFR4Ft1NlIvyqGF+BUWjqpNLHr3GubD +MlMz6xbLFDcx/TTjkzOLQCrdnTKkoibY3nYQ5x9mVu8e5f35bihvwtkvEMp5zFV5 +za+M5jX1uqcnh5DYCL4A1DfZ/Z0Iw28C4ukrXNgHudXO1ERqkbkmi7iF+CAL6ESr +sJNzKhxQGHraavalFLI91w7D3EqRuHLGwVpiG2iqNdP/A7oyZ/mcpk8O0RtsAOJE +JfVuIe4Etn7TDNH560c0fsTn6ITqdJbowvFo+pzWSyFgSlU34IJe6iCsCcBLyirI +4S0qpWKKmyZyk1ge1b2yY6JfirSSVnQd8pI+/1o8n3fnAykzpQH5C01wAVYyzcoh +TTXw5o/G9dLBz79l+pbhBKMcs5YVIGkqCPnqqPk+bNJcM8Q02IB3VGlhn1/mKZIT +Ab9jgE0LmelTNLNNEPY1/f6W9Bq64HI4mCYuUUxIMK91uIHJOF1SQXjqjWOK1jMk +7Bto2wDhFgDn6eXAS0WdBr5lHthvC17+hKxjkT/mMIh1ciaL9vQn/ZQROilQpyc1 +Zcm4FmVYbKF1aDvvFhhKPFRJWyRPYCdQ5FWDbh2DsbRXwMkCwe7E1w6GukdfD1Le +pgwsxqhGgVAOHqnjzV1I3QpE5CVXqicyuhZlfEfnLc8d0vWtJiGylabF0cVpTi5/ +NDGySLXtubTJIni/gYZRST2liaiw0CWEJRAnEoa4Ok/DSUHS8GIFEqFoYDRRE4hR +Td99Iouh8GIvPYsVm1XU0bNvyFznMBoIpor6OU33i/zBwX4G8HYa604o2KTqt74W +1YptomFo9UYajULRjMOsfGPy++2fOWQT4Vgj3m9OzZtStRk8iQJVVB3XldkQphyJ +a0zkPjrlDP6XcWaA7paLQ76k4LkXeycE2tJJVegAh9lQHvP7fMG/XiUoQVZQWy4L diff --git a/README.md b/README.md index c2c6fb0..8589a24 100644 --- a/README.md +++ b/README.md @@ -48,4 +48,34 @@ Instead of having your outsourced bioinformatics vendor send you results by emai We're here to help! Feel free to reach out to support@pluto.bio or email your Pluto customer representative directly. +## Developers +#### Using environment variables locally + +When running tests and developing the `pluto` R package, you will need to decrypt the encrypted `.Renviron` file in this repo. + +**Decrypt the encrypted .Renviron file** + +You will need to decrypt the `.Renviron` file the first time you start working in this repo, and any time other developers have made changes. It's good practice to check regularly for updates. + +``` +openssl enc -d -aes256 -base64 -in .Renviron.encrypted -out .Renviron +``` + +If you make modifications to the `.Renviron` file (e.g. adding new experiments for testing, or other variables), encrypt your file and check it in + +**Encrypt the modified .Renviron file** + +``` +openssl enc -aes256 -base64 -in .Renviron -out .Renviron.encrypted +``` + +Check in the updated `.Renviron.encrypted` when opening a PR so that other developers have the latest changes. + +#### Running tests + +To run tests: `devtools::test()` + +Note that most tests in the test suite are integration tests, so they require a specific API token and uuids present in the `.Renviron` file. + +To build pkgdown site: `pkgdown::build_site()`