[med-svn] [r-cran-evd] 01/02: Add README.source to document binary data files
Andreas Tille
tille at debian.org
Wed Nov 29 15:18:31 UTC 2017
This is an automated email from the git hooks/post-receive script.
tille pushed a commit to branch master
in repository r-cran-evd.
commit 6a48bf49b0b470c1934b06ccbafc71c1ec649145
Author: Andreas Tille <tille at debian.org>
Date: Wed Nov 29 16:13:22 2017 +0100
Add README.source to document binary data files
---
debian/README.source | 120 ++++++++++++++++++++++++++++++++++++++++++++
debian/changelog | 1 +
debian/create_README.source | 26 ++++++++++
3 files changed, 147 insertions(+)
diff --git a/debian/README.source b/debian/README.source
new file mode 100644
index 0000000..666e74f
--- /dev/null
+++ b/debian/README.source
@@ -0,0 +1,120 @@
+Explanation for binary files inside source package according to
+ http://lists.debian.org/debian-devel/2013/09/msg00332.html
+
+Files: data/failure.rda
+Documented: man/failure.Rd
+ Failure times.
+
+Files: data/fox.rda
+Documented: man/fox.Rd
+ The fox data frame has 33 rows and 2 columns.
+ The columns contain maximum annual flood discharges, in units
+ of 1000 cubed feet per second, from the Fox River in Wisconsin,
+ USA at Berlin (upstream) and Wrightstown (downstream), for the
+ years 1918 to 1950.
+ The row names give the years of observation.
+
+Files: data/lisbon.rda
+Documented: man/lisbon.Rd
+ A numeric vector containing annual maximum wind speeds, in
+ kilometers per hour, from 1941 to 1970 at Lisbon, Portugal.
+
+Files: data/lossalae.rda
+Documented: man/lossalae.Rd
+ The lossalae data frame has 1500 rows and 2 columns.
+ The columns contain the indemnity payment (loss), and
+ the allocated loss adjustment expense (alae), both in USD.
+ The latter is the additional expenses associated with the
+ settlement of the claim (e.g. claims investigation expenses
+ and legal fees).
+ The dataset also has an attribute called capped, which
+ gives the row names of the indemnity payments that were capped
+ at their policy limit.
+
+Files: data/ocmulgee.rda
+Documented: man/ocmulgee.Rd
+ The ocmulgee data frame has 40 rows and 2 columns.
+ The columns contain maximum annual flood discharges, in units
+ of 1000 cubed feet per second, from the Ocmulgee River in
+ Georgia, USA at Hawkinsville (upstream) and Macon (downstream),
+ for the years 1910 to 1949.
+ The row names give the years of observation.
+
+Files: data/oldage.rda
+Documented: man/oldage.Rd
+ The oldage data frame has 66 rows and 2 columns.
+ The columns contain the oldest ages at death for men and women in
+ Sweden, for the period 1905--1970.
+ The row names give the years of observation.
+
+Files: data/oxford.rda
+Documented: man/oxford.Rd
+ A numeric vector containing annual maximum temperatures, in degrees
+ Fahrenheit, from 1901 to 1980 at Oxford, England.
+
+Files: data/portpirie.rda
+Documented: man/portpirie.Rd
+ A numeric vector containing annual maximum sea levels, in metres,
+ from 1923 to 1987 at Port Pirie, South Australia.
+
+Files: data/sask.rda
+Documented: man/sask.Rd
+ A numeric vector containing maximum annual flood discharges, in
+ units of 1000 cubic feet per second, of the North Saskachevan
+ River at Edmonton, over a period of 47 years. Unfortunately,
+ the data are ordered from largest to smallest.
+
+Files: data/sealevel.rda
+Documented: man/sealevel.Rd
+ The sealevel data frame has 81 rows and 2 columns.
+ The columns contain annual sea level maxima from 1912 to 1992 at
+ Dover and Harwich respectively, two sites on the coast of Britain.
+ The row names give the years of observation.
+ There are 39 missing values.
+
+Files: data/sealevel2.rda
+Documented: man/sealevel2.Rd
+ The sealevel2 data frame has 81 rows and 3 columns.
+ The first two columns contain annual sea level maxima from 1912
+ to 1992 at Dover and Harwich respectively, two sites on the coast
+ of Britain.
+ The third column is a logical vector denoting whether or not the
+ maxima in a given year are assumed to have derived from the
+ same storm event; this assumption is made if the times of
+ obsevation of the maxima are at most 48 hours apart.
+ The row names give the years of observation.
+ There are 39 missing data values.
+ There are only nine non-missing logical values.
+
+Files: data/uccle.rda
+Documented: man/uccle.Rd
+ The uccle data frame has 35 rows and 4 columns.
+ The columns contain annual rainfall maxima (in millimetres) from
+ 1938 to 1972 at Uccle, Belgium, over the durations of one day,
+ one hour, ten minutes and one minute.
+ The row names give the years of observation.
+
+Files: data/venice.rda
+Documented: man/venice.Rd
+ The venice data frame has 51 rows and 10 columns.
+ The jth column contains the jth largest sea levels in Venice,
+ for the years 1931--1981.
+ Only the largest six measurements are available for the year 1935;
+ the corresponding row contains four missing values.
+ The years for each set of measurements are given as row names.
+ A larger version of this data is available in the dataset
+ venice2.
+
+Files: data/venice2.rda
+Documented: man/venice2.Rd
+ The venice2 data frame has 125 rows and 10 columns.
+ The data was kindly provided by Anthony Davison.
+ The jth column contains the jth largest sea levels in Venice,
+ for the years 1887--2011.
+ This is a larger version of the dataset venice.
+ Only the largest six measurements are available for the year 1935,
+ and only the largest is available for 1922; the corresponding rows
+ contain missing values.
+ The years for each set of measurements are given as row names.
+
+ -- Andreas Tille <tille at debian.org> Wed, 29 Nov 2017 16:14:19 +0100
diff --git a/debian/changelog b/debian/changelog
index 1a5232a..c32d0a8 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -5,6 +5,7 @@ r-cran-evd (2.3-2-2) UNRELEASED; urgency=medium
* Secure URI in watch file
* debhelper 10
* Standards-Version: 4.1.1
+ * Add README.source to document binary data files
-- Andreas Tille <tille at debian.org> Wed, 29 Nov 2017 16:05:38 +0100
diff --git a/debian/create_README.source b/debian/create_README.source
new file mode 100755
index 0000000..7973eb6
--- /dev/null
+++ b/debian/create_README.source
@@ -0,0 +1,26 @@
+#!/bin/sh
+cat <<EOT
+Explanation for binary files inside source package according to
+ http://lists.debian.org/debian-devel/2013/09/msg00332.html
+
+EOT
+
+for rda in ../data/*.rda ; do
+ if [ ! -e ../man/$(basename $rda .rda).Rd ] ; then
+ >&2 echo "Verify documentation for $rda manually"
+ else
+ if ! basename $rda | grep -q "^Fertility" ; then # Fertility is done manually below
+ echo "Files: data/$(basename $rda)"
+ echo "Documented: man/$(basename $rda .rda).Rd"
+ sed -e '0,/^\\title{/d' -e '/^}/,$d' -e 's/^\\description{//' -e 's/^\([^ ]\)/ \1/' ../man/$(basename $rda .rda).Rd | \
+ sed -e 's/\\code{\([^}]\+\)}/\1/g' | \
+ perl -p -e 's/\cM//g' | grep -v '^ *$' | sed -e '/^ \+\\/d' -e 's/} *$/\n#####/' | \
+ sed -e '/^#####/ { N; N; N; N; d; }' | sed -e '/^#####/ { N; N; N; d; }' | sed -e '/^#####/ { N; N; d; }' | sed -e '/^#####/ { N; d; }'
+ echo ""
+ fi
+ fi
+done
+
+cat <<EOT
+ -- Andreas Tille <tille at debian.org> `date -R`
+EOT
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/r-cran-evd.git
More information about the debian-med-commit
mailing list