Project

General

Profile

Actions

Bug #13596

closed

R SDK documentation uses incorrect function names

Added by Alex Plocik almost 6 years ago. Updated over 5 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
SDKs
Target version:
Story points:
-
Release:
Release relationship:
Auto

Description

The R SDK reference page lists functions with incorrect conventions. Essentially, it seems like the python-like function naming in the documentation was abandoned for more R-like versions. As a result, most of the functions are incorrectly documented.

For example, this is part of the tutorial:

collectionList <- arv$collections.list(list(list("name", "like", "Test%")))

Should be replaced with this:

collectionList <- arv$listCollections(list(list("name", "like", "Test%")))

This works to pull a file name's uuid, for example:

uuid <- arv$listCollections(list(list("any", "@@", "GU8N1LS.bam")), limit = 1)$items[[1]]$uuid


Subtasks 1 (0 open1 closed)

Task #13662: ReviewResolvedPeter Amstutz07/05/2018Actions
Actions #1

Updated by Tom Morris almost 6 years ago

  • Assigned To deleted (Tom Morris)
  • Target version set to 2018-07-03 Sprint
Actions #2

Updated by Tom Morris almost 6 years ago

  • Assigned To set to Fuad Muhic
Actions #3

Updated by Fuad Muhic over 5 years ago

  • Status changed from New to In Progress

Reference page is documenting latest version of R SDK in which methods listCollections, getCollections, etc. are replaced with collections.list, collections.get, etc. I assume user is using older version of R SDK.

Actions #4

Updated by Peter Amstutz over 5 years ago

  • Status changed from In Progress to Resolved
Actions #5

Updated by Tom Morris over 5 years ago

  • Tracker changed from Idea to Bug
Actions #6

Updated by Tom Morris over 5 years ago

  • Release set to 13
Actions

Also available in: Atom PDF