From f5a58e1c130eb0f7ad5ba6685f058c0e78743609 Mon Sep 17 00:00:00 2001
From: edward-burn <9583964+edward-burn@users.noreply.github.com>
Date: Fri, 30 Aug 2024 12:13:15 +0100
Subject: [PATCH] fill in description

---
 DESCRIPTION               | 17 ++++++++++++-----
 R/codelistDiagnostics.R   |  9 +++++++++
 man/phenotypeR-package.Rd | 15 +++++++++++++--
 3 files changed, 34 insertions(+), 7 deletions(-)

diff --git a/DESCRIPTION b/DESCRIPTION
index 60473ee..42c4533 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,11 +1,18 @@
 Package: phenotypeR
 Type: Package
-Title: Phenotype a set of cohorts in data mapped to a the OMOP common data model
+Title: Assess Study Cohorts Using a Common Data Model
 Version: 0.0.900
-Author: Who wrote it
-Maintainer: The package maintainer <yourself@somewhere.net>
-Description: More about what it does (maybe more than one line)
-    Use four spaces when indenting paragraphs within the Description.
+Authors@R: c(
+    person("Edward", "Burn", , "edward.burn@ndorms.ox.ac.uk", 
+    role = c("aut", "cre"), comment = c(ORCID = "0000-0002-9286-1128")),
+    person("Marti", "Catala", , "marti.catalasabate@ndorms.ox.ac.uk", 
+    role = c("aut"), comment = c(ORCID = "0000-0003-3308-9905")),
+    person("Xihang", "Chen", , "xihang.chen@ndorms.ox.ac.uk", 
+    role = c("aut"), comment = c(ORCID = "0009-0001-8112-8959")),    
+    person("Albert", "Prats-Uribe", , "albert.prats-uribe@ndorms.ox.ac.uk", 
+    role = "aut", comment = c(ORCID = "0000-0003-1202-9153")))
+Description: Phenotype study cohorts in data mapped to the 
+    Observational Medical Outcomes Partnership Common Data Model.
 License: Apache License (>= 2)
 Encoding: UTF-8
 LazyData: true
diff --git a/R/codelistDiagnostics.R b/R/codelistDiagnostics.R
index f71a81c..49268ff 100644
--- a/R/codelistDiagnostics.R
+++ b/R/codelistDiagnostics.R
@@ -8,6 +8,15 @@
 #' @export
 #'
 #' @examples
+#' \donttest{
+#' library(CohortConstructor)
+#'
+#' cdm <- mockCohortConstructor(conditionOccurrence = TRUE)
+#'
+#' cohort <- conceptCohort(cdm = cdm, conceptSet = list(a = 1), name = "cohort")
+#'
+#' cohort |> attrition()
+#' }
 codelistDiagnostics <- function(cohort){
 
   cdm <- omopgenerics::cdmReference(cohort)
diff --git a/man/phenotypeR-package.Rd b/man/phenotypeR-package.Rd
index be0b9ff..d230ac7 100644
--- a/man/phenotypeR-package.Rd
+++ b/man/phenotypeR-package.Rd
@@ -4,11 +4,11 @@
 \name{phenotypeR-package}
 \alias{phenotypeR}
 \alias{phenotypeR-package}
-\title{phenotypeR: Phenotype a set of cohorts in data mapped to a the OMOP common data model}
+\title{phenotypeR: Assess Study Cohorts Using a Common Data Model}
 \description{
 \if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}}
 
-More about what it does (maybe more than one line) Use four spaces when indenting paragraphs within the Description.
+Phenotype study cohorts in data mapped to the Observational Medical Outcomes Partnership Common Data Model.
 }
 \seealso{
 Useful links:
@@ -16,5 +16,16 @@ Useful links:
   \item \url{https://oxford-pharmacoepi.github.io/phenotypeR/}
 }
 
+}
+\author{
+\strong{Maintainer}: Edward Burn \email{edward.burn@ndorms.ox.ac.uk} (\href{https://orcid.org/0000-0002-9286-1128}{ORCID})
+
+Authors:
+\itemize{
+  \item Marti Catala \email{marti.catalasabate@ndorms.ox.ac.uk} (\href{https://orcid.org/0000-0003-3308-9905}{ORCID})
+  \item Xihang Chen \email{xihang.chen@ndorms.ox.ac.uk} (\href{https://orcid.org/0009-0001-8112-8959}{ORCID})
+  \item Albert Prats-Uribe \email{albert.prats-uribe@ndorms.ox.ac.uk} (\href{https://orcid.org/0000-0003-1202-9153}{ORCID})
+}
+
 }
 \keyword{internal}