-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
first bits of security content added #6
- Loading branch information
Showing
1 changed file
with
32 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,34 @@ | ||
# Security {{< iconify fa6-solid lock >}} {#sec-security} | ||
|
||
xxx | ||
## Package security | ||
|
||
Keeping secrets a secret is an important task and should not be an afterthought - but instead considered from the beginning of a package. | ||
|
||
In general, the rOpenSci Development Guide has good advice on [package security](https://devguide.ropensci.org/package-development-security-best-practices.html). | ||
|
||
As time goes on we'll document here if we have any strong opinions about security related aspects of packages. | ||
|
||
## Data | ||
|
||
Software created in the WILDS may touch PII/PHI data. | ||
|
||
### Package Data | ||
|
||
Do not include any PII/PHI data within a package. If data needs to be included in a package for tests, examples, etc., use fake data that is similar enough to be able to run tests/examples, etc. | ||
|
||
There's many packages in both R (e.g. [charlatan][], [wakefield][]. [fakir][]) and Python (e.g. [faker][]) for creating fake data. | ||
|
||
### Examples | ||
|
||
We strongly encourage all exported, user-facing functions, to have examples. However, when PII/PHI data is a crucial part of an example for a function/class/etc. we need to take extra precautions. | ||
|
||
In package documentation created with pkgdown (see @sec-docs) examples should use fake data included with the package. | ||
|
||
If it makes sense to have examples that run with real data that might be PII/PHI data, those examples should xxxx | ||
|
||
|
||
|
||
[faker]: https://github.com/joke2k/faker | ||
[charlatan]: https://github.com/ropensci/charlatan | ||
[wakefield]: https://github.com/trinker/wakefield | ||
[fakir]: https://github.com/Thinkr-open/fakir/ |