{"id":14068006,"url":"https://github.com/bcgov/safepaths","last_synced_at":"2025-07-30T02:32:38.363Z","repository":{"id":45362922,"uuid":"317370672","full_name":"bcgov/safepaths","owner":"bcgov","description":"An R 📦 to safely set \u0026 use a path to a private network","archived":false,"fork":false,"pushed_at":"2021-12-17T21:17:59.000Z","size":46,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-12-16T17:15:25.115Z","etag":null,"topics":["citz","data-science","r","r-package","rstats"],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bcgov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-30T23:20:33.000Z","updated_at":"2021-12-17T21:16:01.000Z","dependencies_parsed_at":"2022-09-02T00:13:03.060Z","dependency_job_id":null,"html_url":"https://github.com/bcgov/safepaths","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/bcgov/safepaths","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcgov%2Fsafepaths","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcgov%2Fsafepaths/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcgov%2Fsafepaths/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcgov%2Fsafepaths/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bcgov","download_url":"https://codeload.github.com/bcgov/safepaths/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcgov%2Fsafepaths/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267798625,"owners_count":24145727,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["citz","data-science","r","r-package","rstats"],"created_at":"2024-08-13T07:05:53.596Z","updated_at":"2025-07-30T02:32:38.104Z","avatar_url":"https://github.com/bcgov.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"\u003c!-- badges: start --\u003e\n[![R-CMD-check](https://github.com/bcgov/safepaths/workflows/R-CMD-check/badge.svg)](https://github.com/bcgov/safepaths/actions)\n[![img](https://img.shields.io/badge/Lifecycle-Stable-97ca00)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\u003c!-- badges: end --\u003e\n\n\n\n## safepaths\n\nAn R package 📦 to safely set \u0026 use a path to a private network.\n\n### Features\n\nThe package has 3 functions to safely set \u0026 use a path to a private network:\n\n - `set_network_path()`: adds an environment variable called `SAFEPATHS_NETWORK_PATH` to\n    your `.Renviron` file and sets the variable to a provided network\n    path.\n    \n - `get_network_path()`: retrieves the environment variable `SAFEPATHS_NETWORK_PATH`, which is stored in your `.Renviron` file using `set_network_path()`.\n \n - `use_network_path()`: retrieves and uses the stored network path in conjunction with a  provided file or folder path. \n \n \n```{r}\nuse_network_path(\"file.csv\")\nuse_network_path(\"folder_name/file.csv\")\n```\n\n### Installation\n\nYou can install the package directly from this repository. To do so, you\nwill need the [remotes](https://github.com/hadley/devtools/) package:\n\n``` r\ninstall.packages(\"remotes\")\n```\n\nNext, install `safepaths` package using\n`remotes::install_github()`:\n\n``` r\nlibrary(\"remotes\")\ninstall_github(\"bcgov/safepaths\")\n```\n\n### Tips for Finding the Network Path\n\n- *For Windows users*: you can use the mapped drive letter or the UNC network path,\ne.g., `\"P:/folder_name\"` or `\"//UNC_path\"`.\n- *For Mac users*: your mounted network path will look something like `\"/Volumes/server_name/folder_name\"`. You can find the `server_name` for mounted remote drives by opening the Terminal and asking with this code `ls /Volumes`.\n\n\n### Getting Help or Reporting an Issue\n\nTo report bugs/issues/feature requests, please file an [issue](https://github.com/bcgov/safepaths/issues/).\n\n### How to Contribute\n\nIf you would like to contribute to the package, please see our [CONTRIBUTING](CONTRIBUTING.md) guidelines.\n\nPlease note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.\n\n### License\n\n```\nCopyright 2020 Province of British Columbia\n\nLicensed under the Apache License, Version 2.0 (the \u0026quot;License\u0026quot;);\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \u0026quot;AS IS\u0026quot; BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and limitations under the License.\n```\n\n---\n*This project was created using the [bcgovr](https://github.com/bcgov/bcgovr) package.* \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbcgov%2Fsafepaths","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbcgov%2Fsafepaths","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbcgov%2Fsafepaths/lists"}