Merge pull request #4 from amanyiraho/better-readme

cran ready

.Rbuildignore

@@ -14,3 +14,5 @@
 ^\.covrignore$
 ^doc$
 ^Meta$
+^cran-comments\.md$
+^revdep$

DESCRIPTION

@@ -1,26 +1,26 @@
 Package: dhis2r
-Title: R client for the DHIS2 web API
+Title: R Client for the 'DHIS2' Web API
 Version: 0.1.0
 Authors@R: c(
-    person("Robinson", "Amanyiraho", , "[email protected]", role = c("cre", "aut"),
+    person("Robinson", "Amanyiraho", , "[email protected]", role = c("cre", "aut",  "cph"),
            comment = c(ORCID = "0000-0002-7747-1367"))
   )
-Description: Pull data from a DHIS2 instance into R.
+Description: Connet and pull data from a 'DHIS2 (District Health Information Software 2)' instance into R.
 License: MIT + file LICENSE
 URL: https://github.com/amanyiraho/dhis2r
 BugReports: https://github.com/amanyiraho/dhis2r/issues
 Imports: 
-    attempt,
-    curl,
-    dplyr,
-    httr2,
-    R6
+    attempt (>= 0.3.1),
+    curl (>= 4.3.3),
+    dplyr (>= 1.0.10),
+    httr2 (>= 0.2.2),
+    R6 (>= 2.5.1)
 Suggests: 
     covr,
     knitr,
     rmarkdown,
     testthat
-Depends: R (>= 2.10)
+Depends: R (>= 4.1.0)
 Encoding: UTF-8
 VignetteBuilder: knitr
 RoxygenNote: 7.2.3

README.Rmd

@@ -9,7 +9,6 @@ output: github_document
 knitr::opts_chunk$set(
   collapse = TRUE,
   comment = "#>",
-  cache = T,
   fig.path = "man/figures/README-",
   out.width = "100%"
 )

_pkgdown.yml

@@ -1,7 +1,3 @@
 url: http://www.amanyiraho.com/dhis2r/
 template:
   bootstrap: 5
-authors:
-  AFENET:
-    html: <img src='man/figures/afenet-logo.png' width='130' alt='AFENET'/>
-    href: https://www.afenet.net/

cran-comments.md

@@ -0,0 +1,5 @@
+## R CMD check results
+There were no ERRORs, WARNINGs or NOTEs
+
+## Downstream dependencies
+There are currently no downstream dependencies for this package

data-raw/package_setup.R

@@ -14,9 +14,7 @@ my_desc$set("Package", "dhis2r")
 
 #Set your name
 my_desc$set("Authors@R", "c( person('Robinson', 'Amanyiraho', email = '[email protected]',
-            role = c('cre', 'aut'), comment = c(ORCID = '0000-0002-7747-1367')),
-            person('AFENET', role = c('cph')),
-            person('CDC', role = c('fnd')))")
+            role = c('cre', 'aut', 'cph'), comment = c(ORCID = '0000-0002-7747-1367')))")
 
 # Remove some author fields
 my_desc$del("Maintainer")
@@ -25,9 +23,9 @@ my_desc$del("Maintainer")
 my_desc$set_version("0.1.0")
 
 # The title of your package
-my_desc$set(Title = "R client for the DHIS2 web API")
+my_desc$set(Title = "R Client for the 'DHIS2' Web API")
 # The description of your package
-my_desc$set(Description = "Pull data from a DHIS2 instance into R.")
+my_desc$set(Description = "Connet and pull data from a 'DHIS2 (District Health Information Software)' instance into R.")
 # The urls
 my_desc$set("URL", "https://github.com/amanyiraho/dhis2r")
 my_desc$set("BugReports", "https://github.com/amanyiraho/dhis2r/issues")
@@ -41,13 +39,13 @@ use_lifecycle_badge("stable")
 use_news_md()
 
 # Get the dependencies
-use_package("httr2")
+use_package("httr2", min_version = TRUE)
 #use_package("jsonlite")
-use_package("attempt")
-use_package("R6")
+use_package("attempt", min_version = TRUE)
+use_package("R6", min_version = TRUE)
 #use_package("purrr")
-use_package("curl")
-use_package("dplyr")
+use_package("curl", min_version = TRUE)
+use_package("dplyr", min_version = TRUE)
 
 #Suggestion
 use_package("testthat",type = "Suggests")
@@ -56,10 +54,6 @@ use_package("knitr",type = "Suggests")
 use_package("rmarkdown",type = "Suggests")
 
 
-#
-
-
-
 # Clean your description
 use_tidy_description()
 

revdep/.gitignore

@@ -0,0 +1,7 @@
+checks
+library
+checks.noindex
+library.noindex
+cloud.noindex
+data.sqlite
+*.html

revdep/email.yml

@@ -0,0 +1,5 @@
+release_date: ???
+rel_release_date: ???
+my_news_url: ???
+release_version: ???
+release_details: ???