Skip to content

Commit

Permalink
docs: switched to building man pages with markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
kapsner committed Jul 20, 2023
1 parent b1344f3 commit fc16321
Show file tree
Hide file tree
Showing 28 changed files with 172 additions and 155 deletions.
9 changes: 6 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ URL: https://github.com/miracum/dqa-dqastats
BugReports: https://github.com/miracum/dqa-dqastats/issues
Imports:
data.table,
DIZtools (>= 0.0.5),
DIZutils (>= 0.1.1),
DIZtools (>= 0.0.8),
DIZutils (>= 0.1.2),
future,
future.apply,
jsonlite,
Expand All @@ -35,8 +35,11 @@ Suggests:
DT,
lintr,
remotes,
testthat (>= 3.0.0)
testthat
VignetteBuilder:
knitr
Config/testthat/edition: 3
Config/testthat/parallel: false
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
14 changes: 13 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,20 @@

#### Bug fixes

- solving cran issues
([b1344f3](https://gitlab.miracum.org/miracum/dqa/dqastats/tree/b1344f32799b8b70a6813e940f64e84b1ccc3cf4))
- hot-fix to resolve cran errors
([482ea46](https://gitlab.miracum.org/miracum/dqa/dqastats/tree/482ea46623666f2a5fb1a0ff2c6394e1fb40d6e4))
- checking of empty restricting\_date\_format
([a847ba2](https://gitlab.miracum.org/miracum/dqa/dqastats/tree/a847ba201c002acecb5bfd118034e243529fa929))
- fixed typo
([5490bf4](https://gitlab.miracum.org/miracum/dqa/dqastats/tree/5490bf4d2df09135ef85198337681d24def2b04f))
- working on getting dates fixed for oracle
([e3345cc](https://gitlab.miracum.org/miracum/dqa/dqastats/tree/e3345cc9c92c3507abf2c51001986e974868f3cf))
- date-formatting for oracle
([4398f89](https://gitlab.miracum.org/miracum/dqa/dqastats/tree/4398f89a14422328ac08545012f1b5f4b0574e34))
- replace as also for no time filtering
([d5a2444](https://gitlab.miracum.org/miracum/dqa/dqastats/tree/d5a24444b358a3ccb4bfeb3cff3f233177252994))

#### Other changes

Expand All @@ -15,7 +27,7 @@
([91a749c](https://gitlab.miracum.org/miracum/dqa/dqastats/tree/91a749cf1232b86af3d499c60b3cbb06dfe68618))

Full set of changes:
[`v0.3.2...dbb16cb`](https://gitlab.miracum.org/miracum/dqa/dqastats/compare/v0.3.2...dbb16cb)
[`v0.3.2...b1344f3`](https://gitlab.miracum.org/miracum/dqa/dqastats/compare/v0.3.2...b1344f3)

## v0.3.2 (2023-01-23)

Expand Down
3 changes: 1 addition & 2 deletions R/DQA.R
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@
#' @param utils_path A character string. The path to the utils-folder,
#' containing the required app utilities like the MDR and the settings folder.
#' @param mdr_filename A character string.
#' The filename of the MDR e.g. "mdr_example_data.csv"
#' For a detailed description please visit \url{#TODO}.
#' The filename of the MDR e.g. "mdr_example_data.csv".
#' @param output_dir The path to the output folder where all the results will
#' be stored (default: `paste0(tempdir(), "/output/")`).
#' @param logfile_dir The absolute path to folder where the logfile
Expand Down
12 changes: 8 additions & 4 deletions data-raw/devstuffs.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,11 @@ my_desc$set("BugReports",
"https://github.com/miracum/dqa-dqastats/issues")
# Vignette Builder
my_desc$set("VignetteBuilder" = "knitr")

# Testthat stuff
my_desc$set("Config/testthat/parallel" = "false")
my_desc$set("Config/testthat/edition" = "3")
# Roxygen
my_desc$set("Roxygen" = "list(markdown = TRUE)")
# License
my_desc$set("License", "GPL-3")
# Save everyting
Expand Down Expand Up @@ -82,12 +86,12 @@ usethis::use_package("rmarkdown", type = "Imports")
usethis::use_package("stats", type = "Imports")
usethis::use_package("tinytex", type = "Imports")
usethis::use_package("utils", type = "Imports")
usethis::use_package("DIZutils", type = "Imports", min_version = "0.1.1")
usethis::use_package("DIZtools", type = "Imports", min_version = "0.0.5")
usethis::use_package("DIZutils", type = "Imports", min_version = "0.1.2")
usethis::use_package("DIZtools", type = "Imports", min_version = "0.0.8")


# Suggests
usethis::use_package("testthat", type = "Suggests", min_version = "3.0.0")
usethis::use_package("testthat", type = "Suggests")
usethis::use_package("lintr", type = "Suggests")
usethis::use_package("remotes", type = "Suggests")
usethis::use_package("DT", type = "Suggests")
Expand Down
14 changes: 7 additions & 7 deletions man/apply_time_restriciton.Rd

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

22 changes: 11 additions & 11 deletions man/atemp_plausi_results.Rd

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

22 changes: 11 additions & 11 deletions man/check_date_restriction_requirements.Rd

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

6 changes: 3 additions & 3 deletions man/completeness.Rd

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

58 changes: 29 additions & 29 deletions man/create_helper_vars.Rd

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

2 changes: 1 addition & 1 deletion man/create_markdown.Rd

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

2 changes: 1 addition & 1 deletion man/data_loading.Rd

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

22 changes: 11 additions & 11 deletions man/descriptive_results.Rd

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

25 changes: 12 additions & 13 deletions man/dqa.Rd

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

Loading

0 comments on commit fc16321

Please sign in to comment.