From 3d4da7f720720b9445597f94b5c5ad9be6dffb1a Mon Sep 17 00:00:00 2001 From: eblondel Date: Fri, 2 Oct 2015 13:55:59 +0200 Subject: [PATCH] #66 fix vignette building --- .Rbuildignore | 3 ++- DESCRIPTION | 5 +++-- README.md | 5 ++++- doc/{ => slides}/rsdmx_presentation.aux | 0 doc/{ => slides}/rsdmx_presentation.nav | 0 doc/{ => slides}/rsdmx_presentation.out | 0 doc/{ => slides}/rsdmx_presentation.pdf | Bin doc/{ => slides}/rsdmx_presentation.snm | 0 doc/{ => slides}/rsdmx_presentation.synctex.gz | Bin doc/{ => slides}/rsdmx_presentation.tex | 2 +- doc/{ => slides}/rsdmx_presentation.toc | 0 man/rsdmx-package.Rd | 2 +- vignettes/quickstart.Rmd | 9 ++++++--- 13 files changed, 17 insertions(+), 9 deletions(-) rename doc/{ => slides}/rsdmx_presentation.aux (100%) rename doc/{ => slides}/rsdmx_presentation.nav (100%) rename doc/{ => slides}/rsdmx_presentation.out (100%) rename doc/{ => slides}/rsdmx_presentation.pdf (100%) rename doc/{ => slides}/rsdmx_presentation.snm (100%) rename doc/{ => slides}/rsdmx_presentation.synctex.gz (100%) rename doc/{ => slides}/rsdmx_presentation.tex (99%) rename doc/{ => slides}/rsdmx_presentation.toc (100%) diff --git a/.Rbuildignore b/.Rbuildignore index 57ad891..a7eaa60 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,4 +1,5 @@ ^\.travis\.yml$ ^.*\.Rproj$ ^\.Rproj\.user$ -doc* +doc/slides +doc/img diff --git a/DESCRIPTION b/DESCRIPTION index 290276e..6900d5d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: rsdmx Version: 0.5-0 -Date: 2015-09-24 +Date: 2015-10-01 Title: Tools for Reading SDMX Data and Metadata Authors@R: c( person("Emmanuel", "Blondel", role = c("aut", "cre"), email = "emmanuel.blondel1@gmail.com"), @@ -8,11 +8,12 @@ Authors@R: c( Maintainer: Emmanuel Blondel Depends: R (>= 2.15) Imports: methods, XML (>= 3.96-1.1), RCurl, plyr, utils -Suggests: testthat +Suggests: testthat, knitr Description: Set of classes and methods to read data and metadata documents exchanged through the Statistical Data and Metadata Exchange (SDMX) framework, currently focusing on the SDMX XML standard format (SDMX-ML). License: GPL (>= 2) +VignetteBuilder: knitr URL: https://github.com/opensdmx/rsdmx, http://www.sdmx.org BugReports: https://github.com/opensdmx/rsdmx/issues LazyLoad: yes diff --git a/README.md b/README.md index 232afb7..21ddc0b 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,10 @@ ``rsdmx`` is a package to parse/read SDMX data and metadata in R. It provides a set of classes and methods to read data and metadata documents exchanged through the Statistical Data and Metadata Exchange (SDMX) framework. The package currently focuses on the SDMX XML standard format (SDMX-ML). [Learn more](https://github.com/opensdmx/rsdmx/wiki#package_overview). **Collating scattered SDMX data sources** -In spite they are some R package initiatives relying on ``rsdmx`` that aim to provide a wrapper for a _single data source_ (e.g. OECD, EUROSTAT), it is strongly recommended to rely directly on ``rsdmx``. Indeed, one main objective of ``rsdmx`` is to promote and facilitate collating scattered data from a growing number of SDMX data providers, whatever the organization. Pull requests are welcome to support additional data providers by default in ``rsdmx``. + +In spite they are some R package initiatives relying on ``rsdmx`` that aim to provide a wrapper for a _single data source_ (e.g. OECD, EUROSTAT), it is strongly recommended to rely directly on ``rsdmx``. Indeed, one main objective of ``rsdmx`` is to **promote and facilitate collating scattered data** from a growing number of SDMX data providers, whatever the organization. + +It is already possible to query well-known datasources, using the embedded [helpers](https://github.com/opensdmx/rsdmx/blob/master/vignettes/quickstart.Rmd#using-the-helper-approach). Pull requests are welcome to support additional data providers by default in ``rsdmx``. **SDMX standards compliance** diff --git a/doc/rsdmx_presentation.aux b/doc/slides/rsdmx_presentation.aux similarity index 100% rename from doc/rsdmx_presentation.aux rename to doc/slides/rsdmx_presentation.aux diff --git a/doc/rsdmx_presentation.nav b/doc/slides/rsdmx_presentation.nav similarity index 100% rename from doc/rsdmx_presentation.nav rename to doc/slides/rsdmx_presentation.nav diff --git a/doc/rsdmx_presentation.out b/doc/slides/rsdmx_presentation.out similarity index 100% rename from doc/rsdmx_presentation.out rename to doc/slides/rsdmx_presentation.out diff --git a/doc/rsdmx_presentation.pdf b/doc/slides/rsdmx_presentation.pdf similarity index 100% rename from doc/rsdmx_presentation.pdf rename to doc/slides/rsdmx_presentation.pdf diff --git a/doc/rsdmx_presentation.snm b/doc/slides/rsdmx_presentation.snm similarity index 100% rename from doc/rsdmx_presentation.snm rename to doc/slides/rsdmx_presentation.snm diff --git a/doc/rsdmx_presentation.synctex.gz b/doc/slides/rsdmx_presentation.synctex.gz similarity index 100% rename from doc/rsdmx_presentation.synctex.gz rename to doc/slides/rsdmx_presentation.synctex.gz diff --git a/doc/rsdmx_presentation.tex b/doc/slides/rsdmx_presentation.tex similarity index 99% rename from doc/rsdmx_presentation.tex rename to doc/slides/rsdmx_presentation.tex index d3d1b57..ad383df 100644 --- a/doc/rsdmx_presentation.tex +++ b/doc/slides/rsdmx_presentation.tex @@ -181,7 +181,7 @@ \section{Introduction} \columnbreak \hspace{2cm} \raggedleft - \includegraphics[width=6cm]{img/rsdmx.png} + \includegraphics[width=6cm]{./img/rsdmx.png} \end{multicols} diff --git a/doc/rsdmx_presentation.toc b/doc/slides/rsdmx_presentation.toc similarity index 100% rename from doc/rsdmx_presentation.toc rename to doc/slides/rsdmx_presentation.toc diff --git a/man/rsdmx-package.Rd b/man/rsdmx-package.Rd index 0e22476..9fb56f7 100644 --- a/man/rsdmx-package.Rd +++ b/man/rsdmx-package.Rd @@ -16,7 +16,7 @@ Package: \tab rsdmx\cr Type: \tab Package\cr Version : \tab 0.5-0\cr -Date: \tab 2015-09-24\cr +Date: \tab 2015-10-01\cr License: \tab GPL(>=2.0)\cr LazyLoad: \tab yes\cr } diff --git a/vignettes/quickstart.Rmd b/vignettes/quickstart.Rmd index 1bfd0fc..4d83bff 100644 --- a/vignettes/quickstart.Rmd +++ b/vignettes/quickstart.Rmd @@ -27,10 +27,13 @@ For more information about the SDMX standards, you can visit the [SDMX website]( ## How to deal with SDMX in R -[rsdmx](http://cran.r-project.org/web/packages/rsdmx/index.html) offers a low-level set of tools to read **data** and **metadata** in the SDMX-ML format. Its strategy is to make it very easy for the user. For this, a unique function named ``readSDMX`` has to be used, whatever it is a ``data`` or ``metadata`` document, or if it is ``local`` or ``remote`` datasource. +[rsdmx](http://cran.r-project.org/package=rsdmx) offers a low-level set of tools to read **data** and **metadata** in the SDMX-ML format. Its strategy is to make it very easy for the user. For this, a unique function named ``readSDMX`` has to be used, whatever it is a ``data`` or ``metadata`` document, or if it is ``local`` or ``remote`` datasource. -* what ``rsdmx`` does support: a SDMX format abstraction library, with focus on the the main SDMX standard XML format (SDMX-ML), and the support of the three format standard versions (``1.0``, ``2.0``, ``2.1``) -* what ``rsdmx`` does NOT support: an interface to SDMX web-services. Although in a near future``rsdmx`` plans to support ``helpers`` to build SDMX data queries according to SDMX web-services (e.g. SDMX REST API), its primary strategy is to give an emphasis on the SDMX-ML **format**. As result, ``rsdmx`` can be applied to a wider range of datasources, that do not necessarily provide SDMX standard compliant web-services or even may require to download the data prior its reading in R. +* what ``rsdmx`` does support: + +- a SDMX format abstraction library, with focus on the the main SDMX standard XML format (SDMX-ML), and the support of the three format standard versions (``1.0``, ``2.0``, ``2.1``) + +- an interface to SDMX web-services for a list of well-known data providers, such as OECD, EUROSTAT, ECB, UN FAO, UN ILO, etc (a list that should grow in a near future!). See it [in action](https://github.com/opensdmx/rsdmx/blob/master/vignettes/quickstart.Rmd#using-the-helper-approach)! Let's see then how to use ``rsdmx``!