Skip to content

Latest commit

 

History

History
90 lines (58 loc) · 5.1 KB

NEWS.md

File metadata and controls

90 lines (58 loc) · 5.1 KB
Raw

rrefine 2.1.0

This release introduces a new function to summarize project metadata.

New Features

The new refine_project_summary() function queries the running OpenRefine instance and returns high-level summary information about each project. The summary information is pulled from the OpenRefine metadata API and includes project identifier, name, date modified, date created, description, and number of rows in the project.

Tests

Tested with OpenRefine 3.4.1, 3.5.0, and 3.6.2 running on Linux and Mac OSX.

rrefine 2.0.0

This major release introduces a significant new feature that allows users to perform data cleaning operations in OpenRefine through an API query.

New Features

The new functionality passes JSON-specified operations to the running instance via the /command/core/apply-operations endpoint. In addition to the generic refine_operations() that can flexibly accept any valid JSON operation, the rrefine package includes a series of wrapper functions to perform common data cleaning procedures:

  • refine_remove_column(): Remove a column from a project
  • refine_add_column(): Add a column to a project
  • refine_rename_column(): Rename an existing column in a project
  • refine_move_column(): Move a column to a new index
  • refine_transform(): Apply arbitrary text transformations
  • refine_to_lower(): Coerce text to lowercase
  • refine_to_upper(): Coerce text to uppercase
  • refine_to_title(): Coerce text to title case
  • refine_to_null(): Set values to NULL
  • refine_to_empty(): Set text values to empty string ("")
  • refine_to_text(): Coerce value to string
  • refine_to_number(): Coerce value to numeric
  • refine_to_date(): Coerce value to date
  • refine_trim_whitespace(): Remove leading and trailing whitespaces
  • refine_collapse_whitespace(): Collapse consecutive whitespaces to single whitespace
  • refine_unescape_html(): Unescape HTML in string

In addition to the data cleaning operations functionality, the documentation has been updated throughout to point to the current OpenRefine user manual (https://docs.openrefine.org/).

Tests

Tested with OpenRefine 3.4.1 and 3.5.0 running on Linux and Mac OSX.

rrefine 1.1.2

Minor release to incorporate new features.

New Features

  • When using refine_export the user can now specify "col_types" for tabular format returned. Thanks to @joelnitta for the contribution!

rrefine 1.1.1

The only update in this release is the removal of one of the package dependencies (rlist), which has been scheduled to be archived per the CRAN team. This change is required for continued distribution of rrefine via CRAN. Functions from rlist were only used in an unexported rrefine helper, and there are no anticipated user-facing changes in this release.

rrefine 1.1.0

This release includes a number of new features, more robust checks and internal logic, and many improvements to package documentation. Most significantly, this version introduces support for the Cross-Site Request Forgery (CSRF) token in OpenRefine API requests, which is required in certain API calls as of OpenRefine v3.3. This feature is now included in rrefine but operates internally and should be invisible to users. For more information the OpenRefine CSRF protection see: https://github.com/OpenRefine/OpenRefine/wiki/Changes-for-3.3#csrf-protection-changes

New Features

  • The refine_metadata() function is now exported and user-facing.
  • Users can now specify other hosts and/or ports for a running OpenRefine instance (default is still http://127.0.0.1:3333)
  • The refine_upload() function now checks file format based on extension, and allows both .csv and .tsv files to be uploaded.
  • Successful calls to refine_upload(..., open.browser=TRUE) will now redirect the user to the newly created project in the OpenRefine instance.
  • When exporting project data, users can now specify 'tsv' or 'csv' export format. Both will return a tibble with the data in R.
  • Messaging to the user is now more accurate and informative; messages include the given project id/name for the operation where appropriate.
  • The refine_upload() and refine_delete() functions now confirm success of operations by comparing metadata before/after POST requests.
  • The API to construct queries to OpenRefine is now standardized in the refine_query() internal helper function.
  • More robust documentation (inline and user-facing), including descriptions of return values and references to OpenRefine API endpoints used.
  • The refine_id() helper function now validates "project.id" against list of project ids in the running instance.
  • Added news.md to track release notes!

Bug Fixes

  • Calls to refine_delete() and refine_upload() now generate a CSFR token internally.

Tests

Tested with OpenRefine 3.2, 3.3, and 3.4.1 running on Linux and Mac OSX.

rrefine 1.0

  • Initial release!

NOTE The rrefine package was released to CRAN under version 1.0. However, the DESCRIPTION file for that release noted the version as 0.1. All releases from v1.1.0 onwards will maintain consistency between the version in the DESCRIPTION and the version number on the CRAN release.