Skip to content

Commit

Permalink
#66 fix vignette building
Browse files Browse the repository at this point in the history
  • Loading branch information
eblondel committed Oct 2, 2015
1 parent 8b94d34 commit 3d4da7f
Show file tree
Hide file tree
Showing 13 changed files with 17 additions and 9 deletions.
3 changes: 2 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
^\.travis\.yml$
^.*\.Rproj$
^\.Rproj\.user$
doc*
doc/slides
doc/img
5 changes: 3 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
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"),
person("Matthieu", "Stigler", role = c("ctb")))
Maintainer: Emmanuel Blondel <emmanuel.blondel1@gmail.com>
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
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ \section{Introduction}
\columnbreak
\hspace{2cm}
\raggedleft
\includegraphics[width=6cm]{img/rsdmx.png}
\includegraphics[width=6cm]{./img/rsdmx.png}

\end{multicols}

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion man/rsdmx-package.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand Down
9 changes: 6 additions & 3 deletions vignettes/quickstart.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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``!

Expand Down

0 comments on commit 3d4da7f

Please sign in to comment.