{"Package":"rchie","Type":"Package","Title":"A Parser for 'ArchieML'","Version":"1.0.2","Authors@R":"c(\nperson(given = \"Noam\",\nfamily = \"Ross\",\nrole = c(\"aut\", \"cre\"),\nemail = \"noam.ross@gmail.com\",\ncomment = c(ORCID = \"0000-0002-2136-0000\")),\nperson(given = \"Michael\",\nfamily = \"Strickland\",\nrole = \"aut\",\ncomment = \"Author of archieml-js library\")\n)","Description":"Parses the 'ArchieML' format from the New York Times .\nAlso provides utilities for retrieving Google Drive documents for parsing.","License":"Apache License (>= 2.0)","URL":"https://github.com/noamross/rchie,\nhttps://github.com/newsdev/archieml-js","BugReports":"https://github.com/noamross/rchie/issues","Encoding":"UTF-8","Imports":"V8, jsonlite","Suggests":"testthat, covr, googledrive, curl, httpuv","SystemRequirements":"V8 <= 3.15: libv8-3.14-dev (deb), v8-314-devel\n(rpm), v8-3.14 (arch), v8@3.15 (homebrew)","LazyData":"TRUE","RoxygenNote":"6.1.1","NeedsCompilation":"no","Packaged":"2019-05-07 16:40:28 UTC; noamross","Author":"Noam Ross [aut, cre] (),\nMichael Strickland [aut] (Author of archieml-js library)","Maintainer":"Noam Ross ","Repository":"CRAN","Date/Publication":"2019-05-07 22:11:19 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/rchie_1.0.2.tar.gz","jsonAuthors":[{"name":"Noam Ross","email":"noam.ross@gmail.com","maintainer":true},{"name":"Michael Strickland","email":null,"maintainer":false}],"readme":"\n\n\n# rchie: An R parser for ArchieML

\n\n[![Project Status: Active - The project has reached a stable, usable\nstate and is being actively\ndeveloped.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)\n[![CRAN\nversion](http://www.r-pkg.org/badges/version/rchie)](https://cran.r-project.org/package=rchie)\n[![Build\nStatus](https://travis-ci.org/noamross/rchie.svg?branch=master)](https://travis-ci.org/noamross/rchie)\n[![Build\nstatus](https://ci.appveyor.com/api/projects/status/osig88jvixel2taa/branch/master?svg=true)](https://ci.appveyor.com/project/NoamRoss/rchie/branch/master)\n[![codecov.io](https://codecov.io/github/noamross/rchie/coverage.svg?branch=master)](https://codecov.io/github/noamross/rchie?branch=master)\n\n*“Structured text, for an unstructured world.”*\n\nThis package is a wrapper for\n[archieml-js](https://github.com/newsdev/archieml-js), a parser for the\nNew York Times’ ArchieML markup format. ArchieML is designed for\nnon-coders writing documents that need to include some structured data,\nespecially writers producing structured text that will be rendered on\nwebsite or interactive graphics. Learn more about ArchieML’s syntax and\nuse cases at , and see examples of its use\n[here](https://awards.journalists.org/entries/archieml/).\n\n## Installation\n\nInstall **rchie** from CRAN with:\n\n install.packages(\"rchie\")\n\nInstall the development version of **rchie** from GitHub using\n**remotes**, **devtools**, or my zero-dependency preference:\n\n source(\"https://install-github.me/noamross/rchie\")\n\nNote that, because **rchie** uses the V8 package, it has a system\nrequirement of `libv8`. See the [V8\nREADME](https://github.com/jeroen/V8#v8) for instructions.\n\n## Usage\n\n`from_aml` can read ArchieML from a string, file, URL, or connection. It\nreturns an R list:\n\n``` r\nlibrary(rchie)\ndata1 <- \"\n [arrayName]\n \n Jeremy spoke with her on Friday, follow-up scheduled for next week\n name: Amanda\n age: 26\n \n # Contact: 434-555-1234\n name: Tessa\n age: 30\n \n []\n \"\nfrom_aml(data1)\n#> $arrayName\n#> $arrayName[[1]]\n#> $arrayName[[1]]$name\n#> [1] \"Amanda\"\n#> \n#> $arrayName[[1]]$age\n#> [1] \"26\"\n#> \n#> \n#> $arrayName[[2]]\n#> $arrayName[[2]]$name\n#> [1] \"Tessa\"\n#> \n#> $arrayName[[2]]$age\n#> [1] \"30\"\n#> \n#> \n#> \n#> attr(,\"class\")\n#> [1] \"list\" \"from_aml\"\nfrom_aml(\"http://archieml.org/test/1.0/arrays.1.aml\")\n#> $test\n#> [1] \"[array] creates an empty array at array\"\n#> \n#> $result\n#> [1] \"{\\\"array\\\": []}\"\n#> \n#> $array\n#> list()\n#> \n#> attr(,\"class\")\n#> [1] \"list\" \"from_aml\"\n```\n\nIf you want the raw JSON produced by the `archieml-js` parser, use\n`aml_to_json()`.\n\n``` r\naml_to_json(data1, pretty = TRUE)\n#> {\n#> \"arrayName\": [\n#> {\n#> \"name\": \"Amanda\",\n#> \"age\": \"26\"\n#> },\n#> {\n#> \"name\": \"Tessa\",\n#> \"age\": \"30\"\n#> }\n#> ]\n#> }\n#> \n```\n\n### Using Google Docs\n\nSince a common use-case for ArchieML is reading semi-structured text\nwritten in Google Docs, **rchie** includes optional methods to read\nitems from Google Drive. To use them, you must have the\n[**googledrive**](https://googledrive.tidyverse.org/) package installed\nand pass a `drive_id` object to `from_aml()`. Here we pull data from\n[this Google\nDoc](https://drive.google.com/open?id=1oYHXxvzscBBSBhd6xg5ckUEZo3tLytk9zY0VV_Y7SGs):\n\n``` r\nlibrary(googledrive)\ngdata <- from_aml(as_id(\"1pXCkhOsFtLUD8Gr6PIkWlEM1NYXXOW5V\"))\nhead(gdata)\n#> $key\n#> [1] \"value\"\n#> \n#> $`google-link`\n#> [1] \"This is a link.\"\n#> \n#> $`google-link-standalone`\n#> [1] \"http://www.nytimes.com/2016/04/03/us/politics/donald-trump-general-election.html?q=1#1\"\n#> \n#> $`google-link-standalone-raw`\n#> [1] \"http://www.nytimes.com/2016/04/03/us/politics/donald-trump-general-election.html?q=1#1\"\n#> \n#> $`smart-quotes`\n#> [1] \"nytimes.com\"\n#> \n#> $array\n#> $array[[1]]\n#> [1] \"1\"\n#> \n#> $array[[2]]\n#> [1] \"2\"\n```\n\nIf you are using Google Docs to input ArchieML regularly, the [ArchieML\nGoogle Docs\nplugin](https://chrome.google.com/webstore/detail/archieml/jelifjgbakgjapbobohocpbpdoiljokp)\nis quite helpful for previewing parsed data as you type.\n\n## Contributing\n\nI’d love you to contribute to **rchie**\\! I’d especially like some\nexamples of use-cases - R Markdown documents, Shiny Apps, etc. - that I\ncan feature in the documentation. Please take a look the the\n[contributing guidelines](CONTRIBUTING.md).\n\nNote that **rchie** is released with a [Contributor Code of\nConduct](CODE_OF_CONDUCT.md). By contributing to this project, you agree\nto abide by its terms.","jobInfo":{"package":"rchie","version":"1.0.2","parsingStatus":"success","parserVersion":1,"parsedAt":"2019-05-08T00:30:33+0000"}}

Package:	rchie
Type:	Package
Version:	1.0.0
Date:	2018-11-17

Description

Arguments

Details

References