Skip to content

Commit

Permalink
documentation updated
Browse files Browse the repository at this point in the history
Yousuf28 committed Sep 18, 2024
1 parent 6e3f908 commit 13c74f9
Showing 24 changed files with 218 additions and 130 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -20,3 +20,4 @@
^test\.db$
^test_two$
^vignettes/articles$
^vignettes$
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Package: SENDsanitizer
Title: Generate Fake SEND Data
Title: Generate Synthetic SEND Data
Version: 0.0.0.9000
Authors@R:
c(
person("Yousuf", "Ali", email= "md.ali@fda.hhs.gov", role = c( "cre", "aut")),
person("Susan", "Butler", email= "susan.butler@fda.hhs.gov", role = c("aut")),
person("Kevin", "Snyder", email= "kevin.snyder@fda.hhs.gov", role = c("aut")),
person(given = "FDA", role = "cph"))
Description: An R package that that generate fake SEND data based on real SEND data.
Description: An R package that generate synthetic SEND data based on real SEND data.
License: MIT + file LICENSE
URL: https://github.com/phuse-org/SENDsanitizer
BugReports: https://github.com/phuse-org/SENDsanitizer/issues
21 changes: 21 additions & 0 deletions R/app_to_func.R
Original file line number Diff line number Diff line change
@@ -24,6 +24,27 @@
#' In RStudio IDE, you can see all the datasets and visually inspect.\cr
#' default FALSE.
#' @export
#'
#' @examples
#' \dontrun{
#'
#' # To generate one synthetic study dataset from one real study
#'
#' SENDsanitizer::sanitize(path='path/to/directory/of/xpt/files/of/study/',
#' where_to_save='path/to/directory/where/generated/files/should/be/saved/')
#'
#' # To generate one synthetic study dataset from multiple real studies
#'
#' study_01 <- 'path/to/directory/of/xpt/files/of/study_01/'
#' study_02 <- 'path/to/directory/of/xpt/files/of/study_02/'
#' multiple_studies <- c(study_01,study_02)
#'
#' SENDsanitizer::sanitize(path= multiple_studies,
#' where_to_save='path/to/directory/where/generated/files/should/be/saved/')
#'
#' }


#' @import data.table
#' @import utils
#' @importFrom dplyr filter count distinct group_by mutate select
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -28,28 +28,29 @@ install.packages("devtools")
devtools::install_github('phuse-org/SENDsanitizer')
```

## Generate synthetic xpt files
#### To generate one synthetic study dataset from one real study

```
library(SENDsanitizer)
SENDsanitizer::sanitize(path='path/to/directory/of/xpt/files/of/study/',
where_to_save='path/to/directory/where/generated/files/should/save/')
where_to_save='path/to/directory/where/generated/files/should/be/saved/')
```

To use multiple studies as input, put the path in a vector

#### To generate one synthetic study dataset from multiple real study

```
library(SENDsanitizer)
study_01 <- 'path/to/directory/of/xpt/files/of/study_01/'
study_02 <- 'path/to/directory/of/xpt/files/of/study_02/'
multiple_studies <- c(study_01,study_02)
library(SENDsanitizer)
SENDsanitizer::sanitize(path= multiple_studies,
where_to_save='path/to/directory/where/generated/files/should/save/')
where_to_save='path/to/directory/where/generated/files/should/be/saved/')
```

## Install from cloned repo
### Install from cloned repo


Clone the [GitHub](https://github.com/phuse-org/SENDsanitizer) repo
@@ -58,12 +59,11 @@ and set repo as working directory.
```
devtools::load_all(".")
SENDsanitizer::sanitize(path='path/to/directory/of/xpt/files/of/study/',
nubmer=1,
where_to_save='path/to/directory/where/generated/files/should/save/')
where_to_save='path/to/directory/where/generated/files/should/be/saved/')
```


Notes on Example SEND Studies:
Notes on Example SEND Studies:
It is recommended to use multiple example studies for better results. These
SEND format example studies must have similar arms/dosing regimens (with the
option to include or exclude recovery animals), SEND Version, and have the same
14 changes: 9 additions & 5 deletions docs/articles/bw_documentation.html

Large diffs are not rendered by default.

27 changes: 15 additions & 12 deletions docs/articles/dm_documentation.html

Large diffs are not rendered by default.

14 changes: 9 additions & 5 deletions docs/articles/lb_documentation.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/articles/mi_documentation.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/articles/om_documentation.html

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions docs/articles/ts_documentation.html

Large diffs are not rendered by default.

27 changes: 17 additions & 10 deletions docs/articles/tx_documentation.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/authors.html

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

41 changes: 22 additions & 19 deletions docs/index.html

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

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
@@ -11,5 +11,5 @@ articles:
om_documentation: om_documentation.html
ts_documentation: ts_documentation.html
tx_documentation: tx_documentation.html
last_built: 2024-09-18T09:51Z
last_built: 2024-09-18T15:02Z

21 changes: 21 additions & 0 deletions docs/reference/sanitize.html

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

Loading

0 comments on commit 13c74f9

Please sign in to comment.