diff --git a/.gitignore b/.gitignore index 4878151a..7a43a07f 100644 --- a/.gitignore +++ b/.gitignore @@ -62,3 +62,4 @@ inst/doc /touchstone/ /.github/workflows/touchstone-comment.yaml /.github/workflows/touchstone-receive.yaml +/doc/ diff --git a/CITATION.cff b/CITATION.cff deleted file mode 100644 index 0f501915..00000000 --- a/CITATION.cff +++ /dev/null @@ -1,340 +0,0 @@ -# ----------------------------------------------------------- -# CITATION file created with {cffr} R package, v0.5.0 -# See also: https://docs.ropensci.org/cffr/ -# ----------------------------------------------------------- - -cff-version: 1.2.0 -message: 'To cite package "readepi" in publications use:' -type: software -license: MIT -title: 'readepi: Read Data From Health Information Systems' -version: 0.0.1 -abstract: Data import from several health information systems ('HIS'). The current - version of the package covers 'HIS' such as 'MS SQL', 'MySQL', 'PostGRESQL' servers, - 'REDCap', 'DHIS2' and 'Fingertips'. -authors: -- family-names: Mané - given-names: Karim - email: lshkm1@lshtm.ac.uk - orcid: https://orcid.org/0000-0002-9892-2999 -preferred-citation: - type: manual - title: Read Data From Health Information Systems - authors: - - family-names: Mané - given-names: Karim - email: lshkm1@lshtm.ac.uk - orcid: https://orcid.org/0000-0002-9892-2999 - - family-names: Mohammed - given-names: Nuredin - - family-names: Bah - given-names: Bubacarr - - family-names: Ahadzie - given-names: Bankolé - - family-names: Degoot - given-names: Abdoelnaser - year: '2023' - url: https://github.com/epiverse-trace/readepi -repository-code: https://github.com/epiverse-trace/readepi -url: https://epiverse-trace.github.io/readepi -contact: -- family-names: Mané - given-names: Karim - email: lshkm1@lshtm.ac.uk - orcid: https://orcid.org/0000-0002-9892-2999 -keywords: -- data-import -- epidemiology -- epiverse -- health-information-systems -- r -- r-package -references: -- type: software - title: checkmate - abstract: 'checkmate: Fast and Versatile Argument Checks' - notes: Imports - url: https://mllg.github.io/checkmate/ - repository: https://CRAN.R-project.org/package=checkmate - authors: - - family-names: Lang - given-names: Michel - email: michellang@gmail.com - orcid: https://orcid.org/0000-0001-9754-0393 - year: '2023' -- type: software - title: data.table - abstract: 'data.table: Extension of `data.frame`' - notes: Imports - url: https://r-datatable.com - repository: https://CRAN.R-project.org/package=data.table - authors: - - family-names: Dowle - given-names: Matt - email: mattjdowle@gmail.com - - family-names: Srinivasan - given-names: Arun - email: asrini@pm.me - year: '2023' -- type: software - title: DBI - abstract: 'DBI: R Database Interface' - notes: Imports - url: https://dbi.r-dbi.org - repository: https://CRAN.R-project.org/package=DBI - authors: - - name: R Special Interest Group on Databases (R-SIG-DB) - - family-names: Wickham - given-names: Hadley - - family-names: Müller - given-names: Kirill - email: krlmlr+r@mailbox.org - orcid: https://orcid.org/0000-0002-1416-3412 - year: '2023' -- type: software - title: dplyr - abstract: 'dplyr: A Grammar of Data Manipulation' - notes: Imports - url: https://dplyr.tidyverse.org - repository: https://CRAN.R-project.org/package=dplyr - authors: - - family-names: Wickham - given-names: Hadley - email: hadley@posit.co - orcid: https://orcid.org/0000-0003-4757-117X - - family-names: François - given-names: Romain - orcid: https://orcid.org/0000-0002-2444-4226 - - family-names: Henry - given-names: Lionel - - family-names: Müller - given-names: Kirill - orcid: https://orcid.org/0000-0002-1416-3412 - - family-names: Vaughan - given-names: Davis - email: davis@posit.co - orcid: https://orcid.org/0000-0003-4777-038X - year: '2023' -- type: software - title: fingertipsR - abstract: 'fingertipsR: Fingertips Data for Public Health' - notes: Imports - url: https://fingertips.phe.org.uk - authors: - - family-names: Westermann - given-names: Annabel - email: annabel.westermann@dhsc.gov.uk - - family-names: Fox - given-names: Sebastian - email: sebsfox@gmail.com - - family-names: Flowers - given-names: Julian - year: '2023' - version: '>= 1.0.10.9001' -- type: software - title: glue - abstract: 'glue: Interpreted String Literals' - notes: Imports - url: https://glue.tidyverse.org/ - repository: https://CRAN.R-project.org/package=glue - authors: - - family-names: Hester - given-names: Jim - orcid: https://orcid.org/0000-0002-2739-7082 - - family-names: Bryan - given-names: Jennifer - email: jenny@rstudio.com - orcid: https://orcid.org/0000-0002-6983-2759 - year: '2023' -- type: software - title: httr - abstract: 'httr: Tools for Working with URLs and HTTP' - notes: Imports - url: https://httr.r-lib.org/ - repository: https://CRAN.R-project.org/package=httr - authors: - - family-names: Wickham - given-names: Hadley - email: hadley@posit.co - year: '2023' -- type: software - title: magrittr - abstract: 'magrittr: A Forward-Pipe Operator for R' - notes: Imports - url: https://magrittr.tidyverse.org - repository: https://CRAN.R-project.org/package=magrittr - authors: - - family-names: Bache - given-names: Stefan Milton - email: stefan@stefanbache.dk - - family-names: Wickham - given-names: Hadley - email: hadley@rstudio.com - year: '2023' -- type: software - title: odbc - abstract: 'odbc: Connect to ODBC Compatible Databases (using the DBI Interface)' - notes: Imports - url: https://r-dbi.github.io/odbc/ - repository: https://CRAN.R-project.org/package=odbc - authors: - - family-names: Hester - given-names: Jim - - family-names: Wickham - given-names: Hadley - email: hadley@rstudio.com - - family-names: Gjoneski - given-names: Oliver - year: '2023' -- type: software - title: pool - abstract: 'pool: Object Pooling' - notes: Imports - url: http://rstudio.github.io/pool/ - repository: https://CRAN.R-project.org/package=pool - authors: - - family-names: Cheng - given-names: Joe - email: joe@posit.co - - family-names: Borges - given-names: Barbara - - family-names: Wickham - given-names: Hadley - email: hadley@posit.co - year: '2023' -- type: software - title: REDCapR - abstract: 'REDCapR: Interaction Between R and REDCap' - notes: Imports - url: https://ouhscbbmc.github.io/REDCapR/ - repository: https://CRAN.R-project.org/package=REDCapR - authors: - - family-names: Beasley - given-names: Will - email: wibeasley@hotmail.com - orcid: https://orcid.org/0000-0002-5613-5006 - year: '2023' -- type: software - title: RMySQL - abstract: 'RMySQL: Database Interface and ''MySQL'' Driver for R' - notes: Imports - url: https://downloads.mariadb.org/connector-c/ - repository: https://CRAN.R-project.org/package=RMySQL - authors: - - family-names: Ooms - given-names: Jeroen - email: jeroen@berkeley.edu - orcid: https://orcid.org/0000-0002-4035-0289 - - family-names: James - given-names: David - - family-names: DebRoy - given-names: Saikat - - family-names: Wickham - given-names: Hadley - email: hadley@rstudio.com - - family-names: Horner - given-names: Jeffrey - year: '2023' -- type: software - title: bookdown - abstract: 'bookdown: Authoring Books and Technical Documents with R Markdown' - notes: Suggests - url: https://pkgs.rstudio.com/bookdown/ - repository: https://CRAN.R-project.org/package=bookdown - authors: - - family-names: Xie - given-names: Yihui - email: xie@yihui.name - orcid: https://orcid.org/0000-0003-0645-5666 - year: '2023' -- type: software - title: httptest - abstract: 'httptest: A Test Environment for HTTP Requests' - notes: Suggests - url: https://enpiar.com/r/httptest/ - repository: https://CRAN.R-project.org/package=httptest - authors: - - family-names: Richardson - given-names: Neal - email: neal.p.richardson@gmail.com - orcid: https://orcid.org/0009-0002-7992-3520 - year: '2023' -- type: software - title: kableExtra - abstract: 'kableExtra: Construct Complex Table with ''kable'' and Pipe Syntax' - notes: Suggests - url: http://haozhu233.github.io/kableExtra/ - repository: https://CRAN.R-project.org/package=kableExtra - authors: - - family-names: Zhu - given-names: Hao - email: haozhu233@gmail.com - orcid: https://orcid.org/0000-0002-3386-6076 - year: '2023' -- type: software - title: knitr - abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R' - notes: Suggests - url: https://yihui.org/knitr/ - repository: https://CRAN.R-project.org/package=knitr - authors: - - family-names: Xie - given-names: Yihui - email: xie@yihui.name - orcid: https://orcid.org/0000-0003-0645-5666 - year: '2023' -- type: software - title: rmarkdown - abstract: 'rmarkdown: Dynamic Documents for R' - notes: Suggests - url: https://pkgs.rstudio.com/rmarkdown/ - repository: https://CRAN.R-project.org/package=rmarkdown - authors: - - family-names: Allaire - given-names: JJ - email: jj@posit.co - - family-names: Xie - given-names: Yihui - email: xie@yihui.name - orcid: https://orcid.org/0000-0003-0645-5666 - - family-names: Dervieux - given-names: Christophe - email: cderv@posit.co - orcid: https://orcid.org/0000-0003-4474-2498 - - family-names: McPherson - given-names: Jonathan - email: jonathan@posit.co - - family-names: Luraschi - given-names: Javier - - family-names: Ushey - given-names: Kevin - email: kevin@posit.co - - family-names: Atkins - given-names: Aron - email: aron@posit.co - - family-names: Wickham - given-names: Hadley - email: hadley@posit.co - - family-names: Cheng - given-names: Joe - email: joe@posit.co - - family-names: Chang - given-names: Winston - email: winston@posit.co - - family-names: Iannone - given-names: Richard - email: rich@posit.co - orcid: https://orcid.org/0000-0003-3925-190X - year: '2023' -- type: software - title: testthat - abstract: 'testthat: Unit Testing for R' - notes: Suggests - url: https://testthat.r-lib.org - repository: https://CRAN.R-project.org/package=testthat - authors: - - family-names: Wickham - given-names: Hadley - email: hadley@posit.co - year: '2023' - version: '>= 3.0.0' diff --git a/DESCRIPTION b/DESCRIPTION index 4c6e79a7..9875b1d8 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,7 +2,7 @@ Package: readepi Title: Read Data from Health Information Systems Version: 0.0.1 Authors@R: c( - person("Karim", "Mané", , "lshkm1@lshtm.ac.uk", role = c("aut", "cre", "cph"), + person("Karim", "Mané", , "karim.mane@lshtm.ac.uk", role = c("aut", "cre", "cph"), comment = c(ORCID = "0000-0002-9892-2999")), person("Bubacarr", "Bah", , "Bubacarr.Bah1@lshtm.ac.uk", role = "ctb", comment = c(ORCID = "0000-0003-3318-6668")),