From d0e5eea29db3d76acf03e5b27611532bce020ae1 Mon Sep 17 00:00:00 2001 From: Rainer Walke Date: Wed, 6 Nov 2019 10:45:05 +0100 Subject: [PATCH] improved documentation --- DESCRIPTION | 8 ++++---- R/GENESISClasses.R | 2 ++ R/HMDClasses.R | 2 ++ README.md | 11 +++++++++++ man/EX1-class.Rd | 1 + man/LT1-class.Rd | 1 + man/RD1-class.Rd | 1 + man/RE1-class.Rd | 1 + 8 files changed, 23 insertions(+), 4 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 60ffc35..94b2e05 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Package: eoR Type: Package Title: Data Management Package (Exposure and Occurrence Data in R) -Version: 0.3.0 -Date: 2019-10-16 +Version: 0.4.0 +Date: 2019-11-06 Authors@R: c(person("Rainer", "Walke", role = c("aut", "cre"), email = "walke@demogr.mpg.de", comment = c(ORCID = "0000-0002-4269-6531"))) @@ -11,8 +11,8 @@ Description: This data management package provides some helper Demography. Similar to ideas developed in the Bioconductor project bioconductor.org we strive to encapsulate data in easy to use S4 objects. - If original data is provided in a CSV file, the resulting S4 - object contains all information from that CSV file. But the + If original data is provided in a text file, the resulting S4 + object contains all information from that text file. But the information is somehow structured (header, footer, etc). Further the classes provide methods to make a subset for selected calendar years or selected regions. The resulting subset diff --git a/R/GENESISClasses.R b/R/GENESISClasses.R index f0ad0a7..ada3e68 100644 --- a/R/GENESISClasses.R +++ b/R/GENESISClasses.R @@ -18,6 +18,7 @@ NULL #' the version protocol and regional information and the #' death count information as a data.table object. Further it stores a second data.table #' with the total sums information. +#' Try demo(RD1) for a demonstration. #' #' @slot content describes the content #' @slot region regional entity @@ -208,6 +209,7 @@ setValidity("RD1", #' the version protocol and regional information and the #' exposure information as a data.table object. Further it stores a second data.table #' with the total sums information. +#' Try demo(RE1) for a demonstration. #' #' @slot content describes the content #' @slot region regional entity diff --git a/R/HMDClasses.R b/R/HMDClasses.R index 9397c3f..c221b5d 100644 --- a/R/HMDClasses.R +++ b/R/HMDClasses.R @@ -19,6 +19,7 @@ NULL #' the version protocol and regional information and the #' life table as a data.table object. #' The validation adds a pure numeric age AgeLow to the life table. +#' Try demo(LT1) for a demonstration. #' #' @slot content describes the content #' @slot region regional entity @@ -177,6 +178,7 @@ setValidity("LT1", #' the version protocol and regional information and the #' exposure table as a data.table object. #' The validation adds a pure numeric age AgeLow to the exposure table. +#' Try demo(EX1) for a demonstration. #' #' @slot content describes the content #' @slot region regional entity diff --git a/README.md b/README.md index c5ed312..f87f60c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,15 @@ # eoR Data Management Package (Exposure and Occurrence Data in R) +This data management package provides some helper +classes for publicly available data sources (HMD, DESTATIS) in +Demography. We strive to encapsulate data in easy to use S4 objects. + +If original data is provided in a text file, the resulting S4 +object contains all information from that text file. But the +information is somehow structured (header, footer, etc). +Further the classes provide methods to make a subset for selected +calendar years or selected regions. The resulting subset +objects still contain the original header and footer information. + diff --git a/man/EX1-class.Rd b/man/EX1-class.Rd index 7e870da..66b3969 100644 --- a/man/EX1-class.Rd +++ b/man/EX1-class.Rd @@ -101,6 +101,7 @@ An EX1 instance stores the raw header, the content, the version protocol and regional information and the exposure table as a data.table object. The validation adds a pure numeric age AgeLow to the exposure table. +Try demo(EX1) for a demonstration. } \section{Slots}{ diff --git a/man/LT1-class.Rd b/man/LT1-class.Rd index a3041ac..ab7a4a5 100644 --- a/man/LT1-class.Rd +++ b/man/LT1-class.Rd @@ -101,6 +101,7 @@ An LT1 instance stores the raw header, the content, the version protocol and regional information and the life table as a data.table object. The validation adds a pure numeric age AgeLow to the life table. +Try demo(LT1) for a demonstration. } \section{Slots}{ diff --git a/man/RD1-class.Rd b/man/RD1-class.Rd index 651d993..a93be59 100644 --- a/man/RD1-class.Rd +++ b/man/RD1-class.Rd @@ -128,6 +128,7 @@ An RD1 instance stores the raw header, the raw footer, the content, the version protocol and regional information and the death count information as a data.table object. Further it stores a second data.table with the total sums information. +Try demo(RD1) for a demonstration. } \section{Slots}{ diff --git a/man/RE1-class.Rd b/man/RE1-class.Rd index f7725d0..d139f3f 100644 --- a/man/RE1-class.Rd +++ b/man/RE1-class.Rd @@ -128,6 +128,7 @@ An RE1 instance stores the raw header, the raw footer, the content, the version protocol and regional information and the exposure information as a data.table object. Further it stores a second data.table with the total sums information. +Try demo(RE1) for a demonstration. } \section{Slots}{