Resource: Return an R object that will return Medusa records or Medusa...

In misasa/MedusaRClient: Interface to Medusa

Description

Return an R object that will return Medusa records or Medusa records. This class provides a coherent wrapper object-relational mapping for Medusa's RESTful web service.

Usage

Resource

Format

R6Class object.

Value

An R object of R6Class with methods that communicate with Medusa or R objects that correspond to Medusa records.

Fields

name

Stores resource name of your Medusa server

conn

Stores connection object

Methods

Documentation

Return an R object that will return Medusa records or Medusa records. Visit https://github.com/misasa/MedusaRClient/ for detail.

new(NAME)

Return a new R object that corresponds to records having resource name NAME in Medusa. As of March 2018, "specimens", "boxes", "places", "surfaces", "spots", "analyses", "devices", "techniques", "chemistries", "bibs", and "attachment_files" are defined in Medusa.

find(id, options = NULL)

Return a Medusa record with local ID specified.

find_by_ids(ids, options = NULL)

Return Medusa records with local ID specified.

find_by_global_id(id, options = NULL)

Return a Medusa record with glocal ID specified.

find_all(options = NULL)

Return all Medusa records having the resource name.

See Also

connection

Examples

Specimen <- Resource$new("specimens")
Specimen$find_all()
Box <- Resource$new("boxes")
Place <- Resource$new("places")
surface <- Resource$new("surfaces")
Spot <- Resource$new("spots")
Analysis <- Resource$new("analyses")
Device <- Resource$new("devices")
Technique <- Resource$new("techniques")
Chemistry <- Resource$new("chemistries")
Bib <- Resource$new("bibs")
AttachmentFile <- Resource$new("attachment_files")

misasa/MedusaRClient documentation built on June 22, 2019, 1:52 a.m.