Skip to content

Commit

Permalink
adds package level documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cboettig committed Dec 12, 2017
1 parent a913675 commit 3fcdce5
Show file tree
Hide file tree
Showing 7 changed files with 247 additions and 9 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Description: The Resource Description Framework, or 'RDF' is a widely used
This package wraps the low level 'redland' R package which
provides direct bindings to the 'redland' C library. Additionally,
the package supports the newer and more developer friendly
'JSON-LD' format through the `jsonld` package. The package
'JSON-LD' format through the 'jsonld' package. The package
interface takes inspiration from the Python 'rdflib' library.
Depends: R (>= 3.4.1)
License: MIT + file LICENSE
Expand Down
32 changes: 32 additions & 0 deletions R/rdf.R
Original file line number Diff line number Diff line change
Expand Up @@ -278,3 +278,35 @@ text_or_url_to_doc <- function(x, tmp = tempfile()){
return(tmp)
}
}

#' rdflib: Tools to Manipulate and Query Semantic Data
#'
#' The Resource Description Framework, or RDF is a widely used
#' data representation model that forms the cornerstone of the
#' Semantic Web. 'RDF' represents data as a graph rather than
#' the familiar data table or rectangle of relational databases.
#'
#'
#' It has three main goals:
#'
#' \itemize{
#' \item Easily read, write, and convert between all major RDF serialization formats
#' \item Support SPARQL queries to extract data from an RDF graph into a data.frame
#' \item Support JSON-LD format as a first-class citizen in RDF manipulations
#' }
#'
#' For more information, see the Wikipedia pages for RDF, SPARQL, and JSON-LD:
#'
#' #' \itemize{
#' \item \url{https://en.wikipedia.org/wiki/Resource_Description_Framework}
#' \item \url{https://en.wikipedia.org/wiki/SPARQL}
#' \item \url{https://en.wikipedia.org/wiki/JSON-LD}
#' }
#'
#' To learn more about rdflib, start with the vignettes:
#' `browseVignettes(package = "rdflib")`
#'
#'
"_PACKAGE"


4 changes: 2 additions & 2 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
],
"@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', '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.",
"name": "rdflib: Tools to Manipulate and Query Semantic Data",
"codeRepository": "https://github.com/cboettig/rdflib",
"issueTracker": "https://github.com/cboettig/rdflib/issues",
Expand Down Expand Up @@ -230,6 +230,6 @@
],
"contIntegration": "https://travis-ci.org/cboettig/rdflib",
"readme": "https://github.com/cboettig/rdflib/blob/master/README.md",
"fileSize": "16.879KB",
"fileSize": "17.719KB",
"releaseNotes": "https://github.com/cboettig/rdflib/blob/master/NEWS.md"
}
Loading

0 comments on commit 3fcdce5

Please sign in to comment.