Update README, bump version, add badge, add CITATION

ropensci · Feb 21, 2018 · 94f673b · 94f673b
1 parent 09db8a8
commit 94f673b
Show file tree

Hide file tree

Showing 5 changed files with 166 additions and 78 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: rdflib
 Title: Tools to Manipulate and Query Semantic Data
-Version: 0.0.4
+Version: 0.1.0
 Authors@R: person("Carl", "Boettiger", 
                   email = "cboettig@gmail.com", 
                   role = c("aut", "cre", "cph"),
@@ -22,8 +22,8 @@ Description: The Resource Description Framework, or 'RDF' is a widely used
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
-URL: https://github.com/cboettig/rdflib
-BugReports: https://github.com/cboettig/rdflib/issues
+URL: https://github.com/ropensci/rdflib
+BugReports: https://github.com/ropensci/rdflib/issues
 Imports: redland,
     jsonld,
     methods,
@@ -49,5 +49,6 @@ Suggests: magrittr,
     xml2,
     jsonlite,
     repurrrsive,
-    nycflights13
+    nycflights13,
+    codemetar
 VignetteBuilder: knitr
diff --git a/README.Rmd b/README.Rmd
@@ -54,9 +54,7 @@ library(rdflib)
 Parse a file and serialize into a different format:
 
 ```{r parse}
-doc <- system.file("extdata", "dc.rdf", package="redland")
-
-doc %>%
+system.file("extdata/dc.rdf", package="redland") %>%
   rdf_parse() %>%
   rdf_serialize("test.nquads", "nquads")
 ```
@@ -70,11 +68,9 @@ sparql <-
   SELECT ?a ?c
   WHERE { ?a dc:creator ?c . }'
 
-rdf <- rdf_parse(doc)
-rdf
-
-
-rdf %>% rdf_query(sparql)
+system.file("extdata/dc.rdf", package="redland") %>%
+rdf_parse() %>%
+rdf_query(sparql)
 ```
 
 Initialize graph a new object or add triples statements to an existing graph:
@@ -111,20 +107,28 @@ For more information on the JSON-LD RDF API, see <https://json-ld.org/spec/lates
 
 ```{r include=FALSE}
 unlink("test.nquads")
+unlink(out)
+rdf_free(x)
 ```
 
 ----
 
 ## Citing rdflib
 
 
-```{r results="asis"}
-citation("rdflib")
+Please also cite the underlying `redland` library when citing `rdflib`
+
+```{r results="asis", warning=FALSE, echo=FALSE}
+print(citation("rdflib"), "text")
 ```
 
-Please also cite the underlying `redland` library:
+```{r results="asis", warning=FALSE, echo=FALSE}
+print(citation("redland"), "text")
+```
 
-```{r results="asis"}
-citation("redland")
+```{r include=FALSE}
+codemetar::write_codemeta()
 ```
 
+
+[![rofooter](http://ropensci.org/public_images/github_footer.png)](http://ropensci.org)
diff --git a/README.md b/README.md
@@ -30,9 +30,7 @@ library(rdflib)
 Parse a file and serialize into a different format:
 
 ``` r
-doc <- system.file("extdata", "dc.rdf", package="redland")
-
-doc %>%
+system.file("extdata/dc.rdf", package="redland") %>%
   rdf_parse() %>%
   rdf_serialize("test.nquads", "nquads")
 ```
@@ -45,14 +43,9 @@ sparql <-
   SELECT ?a ?c
   WHERE { ?a dc:creator ?c . }'
 
-rdf <- rdf_parse(doc)
-rdf
-#> <http://www.dajobe.org/> <http://purl.org/dc/elements/1.1/description> "The generic home page of Dave Beckett." .
-#> <http://www.dajobe.org/> <http://purl.org/dc/elements/1.1/title> "Dave Beckett's Home Page" .
-#> <http://www.dajobe.org/> <http://purl.org/dc/elements/1.1/creator> "Dave Beckett" .
-
-
-rdf %>% rdf_query(sparql)
+system.file("extdata/dc.rdf", package="redland") %>%
+rdf_parse() %>%
+rdf_query(sparql)
 #> # A tibble: 1 x 2
 #>   a                      c           
 #>   <chr>                  <chr>       
@@ -104,30 +97,10 @@ For more information on the JSON-LD RDF API, see <https://json-ld.org/spec/lates
 Citing rdflib
 -------------
 
-``` r
-citation("rdflib")
-#> Warning in citation("rdflib"): no date field in DESCRIPTION file of package
-#> 'rdflib'
-#> Warning in citation("rdflib"): could not determine year for 'rdflib' from
-#> package DESCRIPTION file
-```
-
-To cite package 'rdflib' in publications use:
-
-Carl Boettiger (NA). rdflib: Tools to Manipulate and Query Semantic Data. R package version 0.0.4. <https://github.com/cboettig/rdflib>
+Please also cite the underlying `redland` library when citing `rdflib`
 
-A BibTeX entry for LaTeX users is
-
-@Manual{, title = {rdflib: Tools to Manipulate and Query Semantic Data}, author = {Carl Boettiger}, note = {R package version 0.0.4}, url = {<https://github.com/cboettig/rdflib>}, }
-
-Please also cite the underlying `redland` library:
-
-``` r
-citation("redland")
-```
+Boettiger C (2018). *rdflib: A high level wrapper around the redland package for common rdf applications*. &lt;URL: <https://doi.org/10.5281/zenodo.1098478>.&gt;.
 
 Jones M, Slaughter P, Ooms J, Boettiger C and Chamberlain S (2016). *redland: RDF Library Bindings in R*. doi: 10.5063/F1VM496B (URL: <http://doi.org/10.5063/F1VM496B>), R package version 1.0.17-9, &lt;URL: <https://github.com/ropensci/redland-bindings/tree/master/R/redland>&gt;.
 
-A BibTeX entry for LaTeX users is
-
-@Manual{, title = {{redland}: RDF Library Bindings in R}, author = {Matthew B. Jones and Peter Slaughter and Jeroen Ooms and Carl Boettiger and Scott Chamberlain}, year = {2016}, note = {R package version 1.0.17-9}, url = {<https://github.com/ropensci/redland-bindings/tree/master/R/redland>}, doi = {10.5063/F1VM496B}, }
+[![rofooter](http://ropensci.org/public_images/github_footer.png)](http://ropensci.org)
diff --git a/codemeta.json b/codemeta.json
@@ -5,26 +5,26 @@
   ],
   "@type": "SoftwareSourceCode",
   "identifier": "rdflib",
-  "description": "The Resource Description Framework, or 'RDF' is a widely used\n             data representation model that forms the cornerstone of the \n             Semantic Web. 'RDF' represents data as a graph rather than \n             the familiar data table or rectangle of relational databases.\n             The 'rdflib' package provides a friendly and concise user interface\n             for performing common tasks on 'RDF' data, such as reading, writing\n             and converting between the various serializations of 'RDF' data,\n             including 'rdfxml', 'turtle', 'nquads', 'ntriples', 'trig', and 'json-ld';\n             creating new 'RDF' graphs, and performing graph queries using 'SPARQL'.\n             This package wraps the low level 'redland' R package which\n             provides direct bindings to the 'redland' C library.  Additionally,\n             the package supports the newer and more developer friendly\n             'JSON-LD' format through the 'jsonld' package. The package\n             interface takes inspiration from the Python 'rdflib' library.",
+  "description": "The Resource Description Framework, or 'RDF' is a widely used\n             data representation model that forms the cornerstone of the \n             Semantic Web. 'RDF' represents data as a graph rather than \n             the familiar data table or rectangle of relational databases.\n             The 'rdflib' package provides a friendly and concise user interface\n             for performing common tasks on 'RDF' data, such as reading, writing\n             and converting between the various serializations of 'RDF' data,\n             including 'rdfxml', 'turtle', 'nquads', 'ntriples', and 'json-ld';\n             creating new 'RDF' graphs, and performing graph queries using 'SPARQL'.\n             This package wraps the low level 'redland' R package which\n             provides direct bindings to the 'redland' C library.  Additionally,\n             the package supports the newer and more developer friendly\n             'JSON-LD' format through the 'jsonld' package. The package\n             interface takes inspiration from the Python 'rdflib' library.",
   "name": "rdflib: Tools to Manipulate and Query Semantic Data",
   "codeRepository": "https://github.com/cboettig/rdflib",
-  "issueTracker": "https://github.com/cboettig/rdflib/issues",
+  "issueTracker": "https://github.com/ropensci/rdflib/issues",
   "license": "https://spdx.org/licenses/MIT",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",
-    "version": "3.4.2",
+    "version": "3.4.3",
     "url": "https://r-project.org"
   },
-  "runtimePlatform": "R version 3.4.2 (2017-09-28)",
+  "runtimePlatform": "R version 3.4.3 (2017-11-30)",
   "author": [
     {
       "@type": "Person",
       "givenName": "Carl",
       "familyName": "Boettiger",
       "email": "cboettig@gmail.com",
-      "@id": "http://orcid.org/0000-0002-1642-628X"
+      "@id": "https://orcid.org/0000-0002-1642-628X"
     }
   ],
   "copyrightHolder": [
@@ -33,15 +33,15 @@
       "givenName": "Carl",
       "familyName": "Boettiger",
       "email": "cboettig@gmail.com",
-      "@id": "http://orcid.org/0000-0002-1642-628X"
+      "@id": "https://orcid.org/0000-0002-1642-628X"
     }
   ],
   "maintainer": {
     "@type": "Person",
     "givenName": "Carl",
     "familyName": "Boettiger",
     "email": "cboettig@gmail.com",
-    "@id": "http://orcid.org/0000-0002-1642-628X"
+    "@id": "https://orcid.org/0000-0002-1642-628X"
   },
   "softwareSuggestions": [
     {
@@ -101,8 +101,8 @@
     },
     {
       "@type": "SoftwareApplication",
-      "identifier": "jsonlite",
-      "name": "jsonlite",
+      "identifier": "jqr",
+      "name": "jqr",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -112,8 +112,8 @@
     },
     {
       "@type": "SoftwareApplication",
-      "identifier": "httr",
-      "name": "httr",
+      "identifier": "DT",
+      "name": "DT",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -123,8 +123,8 @@
     },
     {
       "@type": "SoftwareApplication",
-      "identifier": "xml2",
-      "name": "xml2",
+      "identifier": "tidyverse",
+      "name": "tidyverse",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -134,8 +134,8 @@
     },
     {
       "@type": "SoftwareApplication",
-      "identifier": "jqr",
-      "name": "jqr",
+      "identifier": "dplyr",
+      "name": "dplyr",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -145,8 +145,8 @@
     },
     {
       "@type": "SoftwareApplication",
-      "identifier": "readr",
-      "name": "readr",
+      "identifier": "tidyr",
+      "name": "tidyr",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -156,8 +156,19 @@
     },
     {
       "@type": "SoftwareApplication",
-      "identifier": "dplyr",
-      "name": "dplyr",
+      "identifier": "tibble",
+      "name": "tibble",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Central R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      }
+    },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "purrr",
+      "name": "purrr",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -178,8 +189,63 @@
     },
     {
       "@type": "SoftwareApplication",
-      "identifier": "DT",
-      "name": "DT",
+      "identifier": "httr",
+      "name": "httr",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Central R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      }
+    },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "xml2",
+      "name": "xml2",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Central R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      }
+    },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "jsonlite",
+      "name": "jsonlite",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Central R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      }
+    },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "repurrrsive",
+      "name": "repurrrsive",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Central R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      }
+    },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "nycflights13",
+      "name": "nycflights13",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Central R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      }
+    },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "codemetar",
+      "name": "codemetar",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -223,13 +289,45 @@
     },
     {
       "@type": "SoftwareApplication",
-      "identifier": "R",
-      "name": "R",
-      "version": "3.4.1"
+      "identifier": "stringi",
+      "name": "stringi",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Central R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      }
+    },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "readr",
+      "name": "readr",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Central R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      }
     }
   ],
   "contIntegration": "https://travis-ci.org/cboettig/rdflib",
   "readme": "https://github.com/cboettig/rdflib/blob/master/README.md",
-  "fileSize": "17.719KB",
-  "releaseNotes": "https://github.com/cboettig/rdflib/blob/master/NEWS.md"
+  "fileSize": "48.824KB",
+  "releaseNotes": "https://github.com/cboettig/rdflib/blob/master/NEWS.md",
+  "citation": [
+    {
+      "@type": "SoftwareSourceCode",
+      "datePublished": "2018",
+      "author": [
+        {
+          "@type": "Person",
+          "givenName": "Carl",
+          "familyName": "Boettiger",
+          "email": "cboettig@gmail.com"
+        }
+      ],
+      "name": "rdflib: A high level wrapper around the redland package for common rdf applications",
+      "url": "https://doi.org/10.5281/zenodo.1098478."
+    }
+  ]
 }