€cdocutils.nodes
document
q)q}q(U nametypesq}q(X ���r projectqˆX ���user storiesqNX���synopsisqNX ���classes, fields, and methodsq NX���cranq
ˆX���package designq NX���dataone r client packageq NuUsubstitution_defsq
}qUparse_messagesq]qUcurrent_sourceqNU
decorationqNUautofootnote_startqKUnameidsq}q(hU r-projectqhU user-storiesqhUsynopsisqh Uclasses-fields-and-methodsqh
Ucranqh Upackage-designqh Udataone-r-client-packageq uUchildrenq ]q cdocutils.nodes
section
q )q }q!(U rawsourceq"U�U
referencedq#KUparentq$hUsourceq%Xc���/var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/itk-d1r.txtq&Utagnameq'Usectionq(U
attributesq)}q*(Udupnamesq+]Uclassesq,]Ubackrefsq-]Uidsq.]q/h aUnamesq0]q1h auUlineq2KUdocumentq3hh ]q4(cdocutils.nodes
title
q5)q6}q7(h"X���DataONE R Client Packageq8h$h h%h&h'Utitleq9h)}q:(h+]h,]h-]h.]h0]uh2Kh3hh ]q;cdocutils.nodes
Text
q<X���DataONE R Client Packageq=…q>}q?(h"h8h$h6ubaubh )q@}qA(h"U�h$h h%h&h'h(h)}qB(h+]h,]h-]h.]qChah0]qDhauh2Kh3hh ]qE(h5)qF}qG(h"X���SynopsisqHh$h@h%h&h'h9h)}qI(h+]h,]h-]h.]h0]uh2Kh3hh ]qJh<X���SynopsisqK…qL}qM(h"hHh$hFubaubcdocutils.nodes
paragraph
qN)qO}qP(h"X³��Environmental scientists commonly use the `R Project`_ software system for
statistical analysis and modeling. The R framework is a flexible statistical
computing environment with robust, extensive packages to perform a large
variety of analysis and modeling tasks. Because R is open source and
extensible, it has been widely adopted by the environmental science community,
and it is easy to extend to provide new analysis capabilities.h$h@h%h&h'U paragraphqQh)}qR(h+]h,]h-]h.]h0]uh2Kh3hh ]qS(h<X*���Environmental scientists commonly use the qT…qU}qV(h"X*���Environmental scientists commonly use the h$hOubcdocutils.nodes
reference
qW)qX}qY(h"X ���`R Project`_UresolvedqZKh$hOh'U referenceq[h)}q\(UnameX ���R ProjectUrefuriq]X���http://www.r-project.orgq^h.]h-]h+]h,]h0]uh ]q_h<X ���R Projectq`…qa}qb(h"U�h$hXubaubh<X}�� software system for
statistical analysis and modeling. The R framework is a flexible statistical
computing environment with robust, extensive packages to perform a large
variety of analysis and modeling tasks. Because R is open source and
extensible, it has been widely adopted by the environmental science community,
and it is easy to extend to provide new analysis capabilities.qc…qd}qe(h"X}�� software system for
statistical analysis and modeling. The R framework is a flexible statistical
computing environment with robust, extensive packages to perform a large
variety of analysis and modeling tasks. Because R is open source and
extensible, it has been widely adopted by the environmental science community,
and it is easy to extend to provide new analysis capabilities.h$hOubeubhN)qf}qg(h"X»��The `DataONE R Client Package`_ is an R package that provides access to the
DataONE services that are present at Coordinating Nodes and Member Nodes. The
tool will allow an R user to easily load the d1r package (using CRAN_) and
then use functions in R to search the DataONE system, locate data of interest,
load that data into the R environment, process it using R's various tools, and
then upload derived data and metadata back into DataONE.h$h@h%h&h'hQh)}qh(h+]h,]h-]h.]h0]uh2Kh3hh ]qi(h<X���The qj…qk}ql(h"X���The h$hfubhW)qm}qn(h"X���`DataONE R Client Package`_hZKh$hfh'h[h)}qo(UnameX���DataONE R Client Packageh.]h-]h+]h,]h0]Urefidqph uh ]qqh<X���DataONE R Client Packageqr…qs}qt(h"U�h$hmubaubh<X»��� is an R package that provides access to the
DataONE services that are present at Coordinating Nodes and Member Nodes. The
tool will allow an R user to easily load the d1r package (using qu…qv}qw(h"X»��� is an R package that provides access to the
DataONE services that are present at Coordinating Nodes and Member Nodes. The
tool will allow an R user to easily load the d1r package (using h$hfubhW)qx}qy(h"X���CRAN_hZKh$hfh'h[h)}qz(UnameX���CRANh]X���http://cran.r-project.orgq{h.]h-]h+]h,]h0]uh ]q|h<X���CRANq}…q~}q(h"U�h$hxubaubh<XÜ���) and
then use functions in R to search the DataONE system, locate data of interest,
load that data into the R environment, process it using R's various tools, and
then upload derived data and metadata back into DataONE.q€…q}q‚(h"XÜ���) and
then use functions in R to search the DataONE system, locate data of interest,
load that data into the R environment, process it using R's various tools, and
then upload derived data and metadata back into DataONE.h$hfubeubhN)qƒ}q„(h"X¤��By targeting R in the Investigator Toolkit, we enable a wide variety of
scientists to harness data within the network of Member Nodes, and to
reference the data sets within their R scripts using their unique identifiers
from DataONE. This allows anyone to execute the R script from a paper or
analysis, and the `dataone` library handles the details of finding and accessing
the data needed for analysis or visualization.h$h@h%h&h'hQh)}q…(h+]h,]h-]h.]h0]uh2Kh3hh ]q†(h<X7��By targeting R in the Investigator Toolkit, we enable a wide variety of
scientists to harness data within the network of Member Nodes, and to
reference the data sets within their R scripts using their unique identifiers
from DataONE. This allows anyone to execute the R script from a paper or
analysis, and the q‡…qˆ}q‰(h"X7��By targeting R in the Investigator Toolkit, we enable a wide variety of
scientists to harness data within the network of Member Nodes, and to
reference the data sets within their R scripts using their unique identifiers
from DataONE. This allows anyone to execute the R script from a paper or
analysis, and the h$hƒubcdocutils.nodes
title_reference
qŠ)q‹}qŒ(h"X ���`dataone`h)}q(h+]h,]h-]h.]h0]uh$hƒh ]qŽh<X���dataoneq…q}q‘(h"U�h$h‹ubah'Utitle_referenceq’ubh<Xd��� library handles the details of finding and accessing
the data needed for analysis or visualization.q“…q”}q•(h"Xd��� library handles the details of finding and accessing
the data needed for analysis or visualization.h$hƒubeubcdocutils.nodes
target
q–)q—}q˜(h"X'���.. _R Project: http://www.r-project.orgh#Kh$h@h%h&h'Utargetq™h)}qš(h]h^h.]q›hah-]h+]h,]h0]qœhauh2K h3hh ]ubh–)q}qž(h"X#���.. _CRAN: http://cran.r-project.orgh#Kh$h@h%h&h'h™h)}qŸ(h]h{h.]q hah-]h+]h,]h0]q¡h
auh2K h3hh ]ubeubh )q¢}q£(h"U�h$h h%h&h'h(h)}q¤(h+]h,]h-]h.]q¥hah0]q¦hauh2K h3hh ]q§(h5)q¨}q©(h"X ���User storiesqªh$h¢h%h&h'h9h)}q«(h+]h,]h-]h.]h0]uh2K h3hh ]q¬h<X ���User storiesq…q®}q¯(h"hªh$h¨ubaubcdocutils.nodes
bullet_list
q°)q±}q²(h"U�h$h¢h%h&h'U bullet_listq³h)}q´(UbulletqµX���*h.]h-]h+]h,]h0]uh2K"h3hh ]q¶(cdocutils.nodes
list_item
q·)q¸}q¹(h"XE���A scientist with R on their system can easily install d1r from CRAN_
h$h±h%h&h'U list_itemqºh)}q»(h+]h,]h-]h.]h0]uh2Nh3hh ]q¼hN)q½}q¾(h"XD���A scientist with R on their system can easily install d1r from CRAN_h$h¸h%h&h'hQh)}q¿(h+]h,]h-]h.]h0]uh2K"h ]qÀ(h<X?���A scientist with R on their system can easily install d1r from qÁ…qÂ}qÃ(h"X?���A scientist with R on their system can easily install d1r from h$h½ubhW)qÄ}qÅ(h"X���CRAN_hZKh$h½h'h[h)}qÆ(UnameX���CRANh]h{h.]h-]h+]h,]h0]uh ]qÇh<X���CRANqÈ…qÉ}qÊ(h"U�h$hÄubaubeubaubh·)qË}qÌ(h"X(��A scientist can load a data object using its DataONE identifier from the
DataONE system into R for further processing by other R functions. The
data objects supported should minimally include:
* Data Tables in CSV and other delimited formats
* NetCDF files
* Raster images in various formats
h$h±h%h&h'hºh)}qÍ(h+]h,]h-]h.]h0]uh2Nh3hh ]qÎ(hN)qÏ}qÐ(h"XÀ���A scientist can load a data object using its DataONE identifier from the
DataONE system into R for further processing by other R functions. The
data objects supported should minimally include:qÑh$hËh%h&h'hQh)}qÒ(h+]h,]h-]h.]h0]uh2K$h ]qÓh<XÀ���A scientist can load a data object using its DataONE identifier from the
DataONE system into R for further processing by other R functions. The
data objects supported should minimally include:qÔ…qÕ}qÖ(h"hÑh$hÏubaubcdocutils.nodes
block_quote
q×)qØ}qÙ(h"U�h)}qÚ(h+]h,]h-]h.]h0]uh$hËh ]qÛh°)qÜ}qÝ(h"U�h)}qÞ(hµX���*h.]h-]h+]h,]h0]uh$hØh ]qß(h·)qà}qá(h"X.���Data Tables in CSV and other delimited formatsqâh)}qã(h+]h,]h-]h.]h0]uh$hÜh ]qähN)qå}qæ(h"hâh$hàh%h&h'hQh)}qç(h+]h,]h-]h.]h0]uh2K(h ]qèh<X.���Data Tables in CSV and other delimited formatsqé…qê}që(h"hâh$håubaubah'hºubh·)qì}qí(h"X ���NetCDF filesqîh)}qï(h+]h,]h-]h.]h0]uh$hÜh ]qðhN)qñ}qò(h"hîh$hìh%h&h'hQh)}qó(h+]h,]h-]h.]h0]uh2K)h ]qôh<X ���NetCDF filesqõ…qö}q÷(h"hîh$hñubaubah'hºubh·)qø}qù(h"X!���Raster images in various formats
h)}qú(h+]h,]h-]h.]h0]uh$hÜh ]qûhN)qü}qý(h"X ���Raster images in various formatsqþh$høh%h&h'hQh)}qÿ(h+]h,]h-]h.]h0]uh2K*h ]r���h<X ���Raster images in various formatsr��…r��}r��(h"hþh$hüubaubah'hºubeh'h³ubah'U block_quoter��ubeubh·)r��}r��(h"XÈ���A scientist can use d1r to search for data based on critical metadata,
including title, creator, keywords, abstract, spatial location, temporal
coverage, taxonomic coverage, and other relevant fields
h$h±h%h&h'hºh)}r��(h+]h,]h-]h.]h0]uh2Nh3hh ]r��hN)r ��}r
��(h"X���A scientist can use d1r to search for data based on critical metadata,
including title, creator, keywords, abstract, spatial location, temporal
coverage, taxonomic coverage, and other relevant fieldsr ��h$j��h%h&h'hQh)}r ��(h+]h,]h-]h.]h0]uh2K,h ]r
��h<X���A scientist can use d1r to search for data based on critical metadata,
including title, creator, keywords, abstract, spatial location, temporal
coverage, taxonomic coverage, and other relevant fieldsr��…r��}r��(h"j ��h$j ��ubaubaubh·)r��}r��(h"X´���A scientist can load all of the supported data objects into R by using the
metadata found in a metadata search without directly knowing the
identifiers for individual data objects
h$h±h%h&h'hºh)}r��(h+]h,]h-]h.]h0]uh2Nh3hh ]r��hN)r��}r��(h"X³���A scientist can load all of the supported data objects into R by using the
metadata found in a metadata search without directly knowing the
identifiers for individual data objectsr��h$j��h%h&h'hQh)}r��(h+]h,]h-]h.]h0]uh2K0h ]r��h<X³���A scientist can load all of the supported data objects into R by using the
metadata found in a metadata search without directly knowing the
identifiers for individual data objectsr��…r��}r ��(h"j��h$j��ubaubaubh·)r ��}r ��(h"X��Given a data object loaded from DataONE into R, a scientist can display
the science metadata associated with that object from within the R system
(this might include a link to an external web URI that provides a nice
human readable version of the metadata too)
h$h±h%h&h'hºh)}r ��(h+]h,]h-]h.]h0]uh2Nh3hh ]r ��hN)r!��}r"��(h"X��Given a data object loaded from DataONE into R, a scientist can display
the science metadata associated with that object from within the R system
(this might include a link to an external web URI that provides a nice
human readable version of the metadata too)r#��h$j ��h%h&h'hQh)}r$��(h+]h,]h-]h.]h0]uh2K4h ]r%��h<X��Given a data object loaded from DataONE into R, a scientist can display
the science metadata associated with that object from within the R system
(this might include a link to an external web URI that provides a nice
human readable version of the metadata too)r&��…r'��}r(��(h"j#��h$j!��ubaubaubh·)r)��}r*��(h"X„���A scientist can authenticate with the DataONE system in order to establish
their identity to access restricted objects and services
h$h±h%h&h'hºh)}r+��(h+]h,]h-]h.]h0]uh2Nh3hh ]r,��hN)r-��}r.��(h"Xƒ���A scientist can authenticate with the DataONE system in order to establish
their identity to access restricted objects and servicesr/��h$j)��h%h&h'hQh)}r0��(h+]h,]h-]h.]h0]uh2K9h ]r1��h<Xƒ���A scientist can authenticate with the DataONE system in order to establish
their identity to access restricted objects and servicesr2��…r3��}r4��(h"j/��h$j-��ubaubaubh·)r5��}r6��(h"XŽ���A scientist can upload an R dataframe as a data set with associated
science and system metadata for that object from within the R environment
h$h±h%h&h'hºh)}r7��(h+]h,]h-]h.]h0]uh2Nh3hh ]r8��hN)r9��}r:��(h"X���A scientist can upload an R dataframe as a data set with associated
science and system metadata for that object from within the R environmentr;��h$j5��h%h&h'hQh)}r<��(h+]h,]h-]h.]h0]uh2K<h ]r=��h<X���A scientist can upload an R dataframe as a data set with associated
science and system metadata for that object from within the R environmentr>��…r?��}r@��(h"j;��h$j9��ubaubaubeubeubh )rA��}rB��(h"U�h$h h%h&h'h(h)}rC��(h+]h,]h-]h.]rD��hah0]rE��h auh2K@h3hh ]rF��(h5)rG��}rH��(h"X���Package designrI��h$jA��h%h&h'h9h)}rJ��(h+]h,]h-]h.]h0]uh2K@h3hh ]rK��h<X���Package designrL��…rM��}rN��(h"jI��h$jG��ubaubh )rO��}rP��(h"U�h$jA��h%h&h'h(h)}rQ��(h+]h,]h-]h.]rR��hah0]rS��h auh2KCh3hh ]rT��(h5)rU��}rV��(h"X ���Classes, fields, and methodsrW��h$jO��h%h&h'h9h)}rX��(h+]h,]h-]h.]h0]uh2KCh3hh ]rY��h<X ���Classes, fields, and methodsrZ��…r[��}r\��(h"jW��h$jU��ubaubcdocutils.nodes
note
r]��)r^��}r_��(h"XE��All of the classes and methods in R are inverted (ie, classes don't
contain methods per se, instead, methods are specialized to work on
particular classes, and the class is generally passed in as the first
parameter of the method call. So, all signatures below need to have an
added parameter for this object to be passed in.h$jO��h%h&h'Unoter`��h)}ra��(h+]h,]h-]h.]h0]uh2Nh3hh ]rb��hN)rc��}rd��(h"XE��All of the classes and methods in R are inverted (ie, classes don't
contain methods per se, instead, methods are specialized to work on
particular classes, and the class is generally passed in as the first
parameter of the method call. So, all signatures below need to have an
added parameter for this object to be passed in.re��h$j^��h%h&h'hQh)}rf��(h+]h,]h-]h.]h0]uh2KFh ]rg��h<XE��All of the classes and methods in R are inverted (ie, classes don't
contain methods per se, instead, methods are specialized to work on
particular classes, and the class is generally passed in as the first
parameter of the method call. So, all signatures below need to have an
added parameter for this object to be passed in.rh��…ri��}rj��(h"je��h$jc��ubaubaubj]��)rk��}rl��(h"X��This design is out of date, and instead follows the design in DataPackage.
The R package mainly follows and uses the Java implementation, so does not
need to reimplement this structure. Probably can delete this section, but
leaving for now until DataPackage design is completed.h$jO��h%h&h'j`��h)}rm��(h+]h,]h-]h.]h0]uh2Nh3hh ]rn��hN)ro��}rp��(h"X��This design is out of date, and instead follows the design in DataPackage.
The R package mainly follows and uses the Java implementation, so does not
need to reimplement this structure. Probably can delete this section, but
leaving for now until DataPackage design is completed.rq��h$jk��h%h&h'hQh)}rr��(h+]h,]h-]h.]h0]uh2KMh ]rs��h<X��This design is out of date, and instead follows the design in DataPackage.
The R package mainly follows and uses the Java implementation, so does not
need to reimplement this structure. Probably can delete this section, but
leaving for now until DataPackage design is completed.rt��…ru��}rv��(h"jq��h$jo��ubaubaubh°)rw��}rx��(h"U�h$jO��h%h&h'h³h)}ry��(hµX���*h.]h-]h+]h,]h0]uh2KRh3hh ]rz��(h·)r{��}r|��(h"XŒ��D1Client
* Fields
* endpoint
* username
* cli <D1Client>
* token <AuthToken>
* Constructors
* D1Client(CN_URI)
* Methods
* login(username, password): AuthToken
* logout()
* getEndpoint(): String
* getPackage(pid): DataPackage
* getUsername(): String
* getToken(): AuthToken
* search(): ResultSet
* resolve(pid): [MemberNodeURI]
h$jw��h%Nh'hºh)}r}��(h+]h,]h-]h.]h0]uh2Nh3hh ]r~��cdocutils.nodes
definition_list
r��)r€��}r��(h"U�h)}r‚��(h+]h,]h-]h.]h0]uh$j{��h ]rƒ��cdocutils.nodes
definition_list_item
r„��)r…��}r†��(h"X|��D1Client
* Fields
* endpoint
* username
* cli <D1Client>
* token <AuthToken>
* Constructors
* D1Client(CN_URI)
* Methods
* login(username, password): AuthToken
* logout()
* getEndpoint(): String
* getPackage(pid): DataPackage
* getUsername(): String
* getToken(): AuthToken
* search(): ResultSet
* resolve(pid): [MemberNodeURI]
h$j€��h%h&h'Udefinition_list_itemr‡��h)}rˆ��(h+]h,]h-]h.]h0]uh2Kbh ]r‰��(cdocutils.nodes
term
rŠ��)r‹��}rŒ��(h"X���D1Clientr��h$j…��h%h&h'UtermrŽ��h)}r��(h+]h,]h-]h.]h0]uh2Kbh ]r��h<X���D1Clientr‘��…r’��}r“��(h"j��h$j‹��ubaubcdocutils.nodes
definition
r”��)r•��}r–��(h"U�h)}r—��(h+]h,]h-]h.]h0]uh$j…��h ]r˜��h°)r™��}rš��(h"U�h)}r›��(hµX���*h.]h-]h+]h,]h0]uh$j•��h ]rœ��(h·)r��}rž��(h"XI���Fields
* endpoint
* username
* cli <D1Client>
* token <AuthToken>h)}rŸ��(h+]h,]h-]h.]h0]uh$j™��h ]r ��j��)r¡��}r¢��(h"U�h)}r£��(h+]h,]h-]h.]h0]uh$j��h ]r¤��j„��)r¥��}r¦��(h"XA���Fields
* endpoint
* username
* cli <D1Client>
* token <AuthToken>h$j¡��h%h&h'j‡��h)}r§��(h+]h,]h-]h.]h0]uh2KVh ]r¨��(jŠ��)r©��}rª��(h"X���Fieldsr«��h$j¥��h%h&h'jŽ��h)}r¬��(h+]h,]h-]h.]h0]uh2KVh ]r��h<X���Fieldsr®��…r¯��}r°��(h"j«��h$j©��ubaubj”��)r±��}r²��(h"U�h)}r³��(h+]h,]h-]h.]h0]uh$j¥��h ]r´��h°)rµ��}r¶��(h"U�h)}r·��(hµX���*h.]h-]h+]h,]h0]uh$j±��h ]r¸��(h·)r¹��}rº��(h"X���endpointr»��h)}r¼��(h+]h,]h-]h.]h0]uh$jµ��h ]r½��hN)r¾��}r¿��(h"j»��h$j¹��h%h&h'hQh)}rÀ��(h+]h,]h-]h.]h0]uh2KTh ]rÁ��h<X���endpointrÂ��…rÃ��}rÄ��(h"j»��h$j¾��ubaubah'hºubh·)rÅ��}rÆ��(h"X���usernamerÇ��h)}rÈ��(h+]h,]h-]h.]h0]uh$jµ��h ]rÉ��hN)rÊ��}rË��(h"jÇ��h$jÅ��h%h&h'hQh)}rÌ��(h+]h,]h-]h.]h0]uh2KUh ]rÍ��h<X���usernamerÎ��…rÏ��}rÐ��(h"jÇ��h$jÊ��ubaubah'hºubh·)rÑ��}rÒ��(h"X���cli <D1Client>rÓ��h)}rÔ��(h+]h,]h-]h.]h0]uh$jµ��h ]rÕ��hN)rÖ��}r×��(h"jÓ��h$jÑ��h%h&h'hQh)}rØ��(h+]h,]h-]h.]h0]uh2KVh ]rÙ��h<X���cli <D1Client>rÚ��…rÛ��}rÜ��(h"jÓ��h$jÖ��ubaubah'hºubh·)rÝ��}rÞ��(h"X���token <AuthToken>rß��h)}rà��(h+]h,]h-]h.]h0]uh$jµ��h ]rá��hN)râ��}rã��(h"jß��h$jÝ��h%h&h'hQh)}rä��(h+]h,]h-]h.]h0]uh2KWh ]rå��h<X���token <AuthToken>ræ��…rç��}rè��(h"jß��h$jâ��ubaubah'hºubeh'h³ubah'U
definitionré��ubeubah'Udefinition_listrê��ubah'hºubh·)rë��}rì��(h"X!���Constructors
* D1Client(CN_URI)h)}rí��(h+]h,]h-]h.]h0]uh$j™��h ]rî��j��)rï��}rð��(h"U�h)}rñ��(h+]h,]h-]h.]h0]uh$jë��h ]rò��j„��)ró��}rô��(h"X ���Constructors
* D1Client(CN_URI)h$jï��h%h&h'j‡��h)}rõ��(h+]h,]h-]h.]h0]uh2KXh ]rö��(jŠ��)r÷��}rø��(h"X ���Constructorsrù��h$jó��h%h&h'jŽ��h)}rú��(h+]h,]h-]h.]h0]uh2KXh ]rû��h<X ���Constructorsrü��…rý��}rþ��(h"jù��h$j÷��ubaubj”��)rÿ��}r���(h"U�h)}r��(h+]h,]h-]h.]h0]uh$jó��h ]r��h°)r��}r��(h"U�h)}r��(hµX���*h.]h-]h+]h,]h0]uh$jÿ��h ]r��h·)r��}r��(h"X���D1Client(CN_URI)r ��h)}r
��(h+]h,]h-]h.]h0]uh$j��h ]r ��hN)r ��}r
��(h"j ��h$j��h%h&h'hQh)}r��(h+]h,]h-]h.]h0]uh2KYh ]r��h<X���D1Client(CN_URI)r��…r��}r��(h"j ��h$j ��ubaubah'hºubah'h³ubah'jé��ubeubah'jê��ubah'hºubh·)r��}r��(h"Xç���Methods
* login(username, password): AuthToken
* logout()
* getEndpoint(): String
* getPackage(pid): DataPackage
* getUsername(): String
* getToken(): AuthToken
* search(): ResultSet
* resolve(pid): [MemberNodeURI]
h)}r��(h+]h,]h-]h.]h0]uh$j™��h ]r��j��)r��}r��(h"U�h)}r��(h+]h,]h-]h.]h0]uh$j��h ]r��j„��)r��}r ��(h"X×���Methods
* login(username, password): AuthToken
* logout()
* getEndpoint(): String
* getPackage(pid): DataPackage
* getUsername(): String
* getToken(): AuthToken
* search(): ResultSet
* resolve(pid): [MemberNodeURI]
h$j��h%h&h'j‡��h)}r ��(h+]h,]h-]h.]h0]uh2Kbh ]r ��(jŠ��)r ��}r ��(h"X���Methodsr!��h$j��h%h&h'jŽ��h)}r"��(h+]h,]h-]h.]h0]uh2Kbh ]r#��h<X���Methodsr$��…r%��}r&��(h"j!��h$j ��ubaubj”��)r'��}r(��(h"U�h)}r)��(h+]h,]h-]h.]h0]uh$j��h ]r*��h°)r+��}r,��(h"U�h)}r-��(hµX���*h.]h-]h+]h,]h0]uh$j'��h ]r.��(h·)r/��}r0��(h"X$���login(username, password): AuthTokenr1��h)}r2��(h+]h,]h-]h.]h0]uh$j+��h ]r3��hN)r4��}r5��(h"j1��h$j/��h%h&h'hQh)}r6��(h+]h,]h-]h.]h0]uh2K[h ]r7��h<X$���login(username, password): AuthTokenr8��…r9��}r:��(h"j1��h$j4��ubaubah'hºubh·)r;��}r<��(h"X���logout()r=��h)}r>��(h+]h,]h-]h.]h0]uh$j+��h ]r?��hN)r@��}rA��(h"j=��h$j;��h%h&h'hQh)}rB��(h+]h,]h-]h.]h0]uh2K\h ]rC��h<X���logout()rD��…rE��}rF��(h"j=��h$j@��ubaubah'hºubh·)rG��}rH��(h"X���getEndpoint(): StringrI��h)}rJ��(h+]h,]h-]h.]h0]uh$j+��h ]rK��hN)rL��}rM��(h"jI��h$jG��h%h&h'hQh)}rN��(h+]h,]h-]h.]h0]uh2K]h ]rO��h<X���getEndpoint(): StringrP��…rQ��}rR��(h"jI��h$jL��ubaubah'hºubh·)rS��}rT��(h"X ���getPackage(pid): DataPackagerU��h)}rV��(h+]h,]h-]h.]h0]uh$j+��h ]rW��hN)rX��}rY��(h"jU��h$jS��h%h&h'hQh)}rZ��(h+]h,]h-]h.]h0]uh2K^h ]r[��h<X ���getPackage(pid): DataPackager\��…r]��}r^��(h"jU��h$jX��ubaubah'hºubh·)r_��}r`��(h"X���getUsername(): Stringra��h)}rb��(h+]h,]h-]h.]h0]uh$j+��h ]rc��hN)rd��}re��(h"ja��h$j_��h%h&h'hQh)}rf��(h+]h,]h-]h.]h0]uh2K_h ]rg��h<X���getUsername(): Stringrh��…ri��}rj��(h"ja��h$jd��ubaubah'hºubh·)rk��}rl��(h"X���getToken(): AuthTokenrm��h)}rn��(h+]h,]h-]h.]h0]uh$j+��h ]ro��hN)rp��}rq��(h"jm��h$jk��h%h&h'hQh)}rr��(h+]h,]h-]h.]h0]uh2K`h ]rs��h<X���getToken(): AuthTokenrt��…ru��}rv��(h"jm��h$jp��ubaubah'hºubh·)rw��}rx��(h"X���search(): ResultSetry��h)}rz��(h+]h,]h-]h.]h0]uh$j+��h ]r{��hN)r|��}r}��(h"jy��h$jw��h%h&h'hQh)}r~��(h+]h,]h-]h.]h0]uh2Kah ]r��h<X���search(): ResultSetr€��…r��}r‚��(h"jy��h$j|��ubaubah'hºubh·)rƒ��}r„��(h"X ���resolve(pid): [MemberNodeURI]
h)}r…��(h+]h,]h-]h.]h0]uh$j+��h ]r†��hN)r‡��}rˆ��(h"X ���resolve(pid): [MemberNodeURI]r‰��h$jƒ��h%h&h'hQh)}rŠ��(h+]h,]h-]h.]h0]uh2Kbh ]r‹��h<X ���resolve(pid): [MemberNodeURI]rŒ��…r��}rŽ��(h"j‰��h$j‡��ubaubah'hºubeh'h³ubah'jé��ubeubah'jê��ubah'hºubeh'h³ubah'jé��ubeubah'jê��ubaubh·)r��}r��(h"Xl��DataPackage
* Fields
* identifier
* scimeta
* sysmeta
* [dataObject]
* Constructors
* DataPackage(identifier, scimeta, sysmeta)
* Methods
* addData(DataObject): DataPackage
* getDataObjectCount(): int
* getDataObject(index): DataObject
* getTitle(): String
* getCreator(): String
* getDisplayURL(): String
h$jw��h%Nh'hºh)}r‘��(h+]h,]h-]h.]h0]uh2Nh3hh ]r’��j��)r“��}r”��(h"U�h)}r•��(h+]h,]h-]h.]h0]uh$j��h ]r–��j„��)r—��}r˜��(h"X^��DataPackage
* Fields
* identifier
* scimeta
* sysmeta
* [dataObject]
* Constructors
* DataPackage(identifier, scimeta, sysmeta)
* Methods
* addData(DataObject): DataPackage
* getDataObjectCount(): int
* getDataObject(index): DataObject
* getTitle(): String
* getCreator(): String
* getDisplayURL(): String
h$j“��h%h&h'j‡��h)}r™��(h+]h,]h-]h.]h0]uh2Krh ]rš��(jŠ��)r›��}rœ��(h"X ���DataPackager��h$j—��h%h&h'jŽ��h)}rž��(h+]h,]h-]h.]h0]uh2Krh ]rŸ��h<X ���DataPackager ��…r¡��}r¢��(h"j��h$j›��ubaubj”��)r£��}r¤��(h"U�h)}r¥��(h+]h,]h-]h.]h0]uh$j—��h ]r¦��h°)r§��}r¨��(h"U�h)}r©��(hµX���*h.]h-]h+]h,]h0]uh$j£��h ]rª��(h·)r«��}r¬��(h"X>���Fields
* identifier
* scimeta
* sysmeta
* [dataObject]h)}r��(h+]h,]h-]h.]h0]uh$j§��h ]r®��j��)r¯��}r°��(h"U�h)}r±��(h+]h,]h-]h.]h0]uh$j«��h ]r²��j„��)r³��}r´��(h"X6���Fields
* identifier
* scimeta
* sysmeta
* [dataObject]h$j¯��h%h&h'j‡��h)}rµ��(h+]h,]h-]h.]h0]uh2Khh ]r¶��(jŠ��)r·��}r¸��(h"X���Fieldsr¹��h$j³��h%h&h'jŽ��h)}rº��(h+]h,]h-]h.]h0]uh2Khh ]r»��h<X���Fieldsr¼��…r½��}r¾��(h"j¹��h$j·��ubaubj”��)r¿��}rÀ��(h"U�h)}rÁ��(h+]h,]h-]h.]h0]uh$j³��h ]rÂ��h°)rÃ��}rÄ��(h"U�h)}rÅ��(hµX���*h.]h-]h+]h,]h0]uh$j¿��h ]rÆ��(h·)rÇ��}rÈ��(h"X
���identifierr��h)}r��(h+]h,]h-]h.]h0]uh$j��h ]r��hN)r��}r��(h"j��h$j��h%h&h'hQh)}r��(h+]h,]h-]h.]h0]uh2Kfh ]r��h<X
���identifierrÐ��…rÑ��}rÒ��(h"jÉ��h$jÌ��ubaubah'hºubh·)rÓ��}rÔ��(h"X���scimetarÕ��h)}rÖ��(h+]h,]h-]h.]h0]uh$jÃ��h ]r×��hN)rØ��}rÙ��(h"jÕ��h$jÓ��h%h&h'hQh)}rÚ��(h+]h,]h-]h.]h0]uh2Kgh ]rÛ��h<X���scimetarÜ��…rÝ��}rÞ��(h"jÕ��h$jØ��ubaubah'hºubh·)rß��}rà��(h"X���sysmetará��h)}râ��(h+]h,]h-]h.]h0]uh$jÃ��h ]rã��hN)rä��}rå��(h"já��h$jß��h%h&h'hQh)}ræ��(h+]h,]h-]h.]h0]uh2Khh ]rç��h<X���sysmetarè��…ré��}rê��(h"já��h$jä��ubaubah'hºubh·)rë��}rì��(h"X ���[dataObject]rí��h)}rî��(h+]h,]h-]h.]h0]uh$jÃ��h ]rï��hN)rð��}rñ��(h"jí��h$jë��h%h&h'hQh)}rò��(h+]h,]h-]h.]h0]uh2Kih ]ró��h<X ���[dataObject]rô��…rõ��}rö��(h"jí��h$jð��ubaubah'hºubeh'h³ubah'jé��ubeubah'jê��ubah'hºubh·)r÷��}rø��(h"X:���Constructors
* DataPackage(identifier, scimeta, sysmeta)h)}rù��(h+]h,]h-]h.]h0]uh$j§��h ]rú��j��)rû��}rü��(h"U�h)}rý��(h+]h,]h-]h.]h0]uh$j÷��h ]rþ��j„��)rÿ��}r���(h"X8���Constructors
* DataPackage(identifier, scimeta, sysmeta)h$jû��h%h&h'j‡��h)}r��(h+]h,]h-]h.]h0]uh2Kjh ]r��(jŠ��)r��}r��(h"X ���Constructorsr��h$jÿ��h%h&h'jŽ��h)}r��(h+]h,]h-]h.]h0]uh2Kjh ]r��h<X ���Constructorsr��…r ��}r
��(h"j��h$j��ubaubj”��)r ��}r ��(h"U�h)}r
��(h+]h,]h-]h.]h0]uh$jÿ��h ]r��h°)r��}r��(h"U�h)}r��(hµX���*h.]h-]h+]h,]h0]uh$j ��h ]r��h·)r��}r��(h"X)���DataPackage(identifier, scimeta, sysmeta)r��h)}r��(h+]h,]h-]h.]h0]uh$j��h ]r��hN)r��}r��(h"j��h$j��h%h&h'hQh)}r��(h+]h,]h-]h.]h0]uh2Kkh ]r��h<X)���DataPackage(identifier, scimeta, sysmeta)r ��…r ��}r ��(h"j��h$j��ubaubah'hºubah'h³ubah'jé��ubeubah'jê��ubah'hºubh·)r ��}r ��(h"X¼���Methods
* addData(DataObject): DataPackage
* getDataObjectCount(): int
* getDataObject(index): DataObject
* getTitle(): String
* getCreator(): String
* getDisplayURL(): String
h)}r!��(h+]h,]h-]h.]h0]uh$j§��h ]r"��j��)r#��}r$��(h"U�h)}r%��(h+]h,]h-]h.]h0]uh$j ��h ]r&��j„��)r'��}r(��(h"X°���Methods
* addData(DataObject): DataPackage
* getDataObjectCount(): int
* getDataObject(index): DataObject
* getTitle(): String
* getCreator(): String
* getDisplayURL(): String
h$j#��h%h&h'j‡��h)}r)��(h+]h,]h-]h.]h0]uh2Krh ]r*��(jŠ��)r+��}r,��(h"X���Methodsr-��h$j'��h%h&h'jŽ��h)}r.��(h+]h,]h-]h.]h0]uh2Krh ]r/��h<X���Methodsr0��…r1��}r2��(h"j-��h$j+��ubaubj”��)r3��}r4��(h"U�h)}r5��(h+]h,]h-]h.]h0]uh$j'��h ]r6��h°)r7��}r8��(h"U�h)}r9��(hµX���*h.]h-]h+]h,]h0]uh$j3��h ]r:��(h·)r;��}r<��(h"X ���addData(DataObject): DataPackager=��h)}r>��(h+]h,]h-]h.]h0]uh$j7��h ]r?��hN)r@��}rA��(h"j=��h$j;��h%h&h'hQh)}rB��(h+]h,]h-]h.]h0]uh2Kmh ]rC��h<X ���addData(DataObject): DataPackagerD��…rE��}rF��(h"j=��h$j@��ubaubah'hºubh·)rG��}rH��(h"X���getDataObjectCount(): intrI��h)}rJ��(h+]h,]h-]h.]h0]uh$j7��h ]rK��hN)rL��}rM��(h"jI��h$jG��h%h&h'hQh)}rN��(h+]h,]h-]h.]h0]uh2Knh ]rO��h<X���getDataObjectCount(): intrP��…rQ��}rR��(h"jI��h$jL��ubaubah'hºubh·)rS��}rT��(h"X ���getDataObject(index): DataObjectrU��h)}rV��(h+]h,]h-]h.]h0]uh$j7��h ]rW��hN)rX��}rY��(h"jU��h$jS��h%h&h'hQh)}rZ��(h+]h,]h-]h.]h0]uh2Koh ]r[��h<X ���getDataObject(index): DataObjectr\��…r]��}r^��(h"jU��h$jX��ubaubah'hºubh·)r_��}r`��(h"X���getTitle(): Stringra��h)}rb��(h+]h,]h-]h.]h0]uh$j7��h ]rc��hN)rd��}re��(h"ja��h$j_��h%h&h'hQh)}rf��(h+]h,]h-]h.]h0]uh2Kph ]rg��h<X���getTitle(): Stringrh��…ri��}rj��(h"ja��h$jd��ubaubah'hºubh·)rk��}rl��(h"X���getCreator(): Stringrm��h)}rn��(h+]h,]h-]h.]h0]uh$j7��h ]ro��hN)rp��}rq��(h"jm��h$jk��h%h&h'hQh)}rr��(h+]h,]h-]h.]h0]uh2Kqh ]rs��h<X���getCreator(): Stringrt��…ru��}rv��(h"jm��h$jp��ubaubah'hºubh·)rw��}rx��(h"X���getDisplayURL(): String
h)}ry��(h+]h,]h-]h.]h0]uh$j7��h ]rz��hN)r{��}r|��(h"X���getDisplayURL(): Stringr}��h$jw��h%h&h'hQh)}r~��(h+]h,]h-]h.]h0]uh2Krh ]r��h<X���getDisplayURL(): Stringr€��…r��}r‚��(h"j}��h$j{��ubaubah'hºubeh'h³ubah'jé��ubeubah'jê��ubah'hºubeh'h³ubah'jé��ubeubah'jê��ubaubh·)rƒ��}r„��(h"X‰���DataObject
* Fields
* sysmeta
* databytes
* Constructors
* DataObject(Identifier, SystemMetadata, databytes)
* Methods
h$jw��h%Nh'hºh)}r…��(h+]h,]h-]h.]h0]uh2Nh3hh ]r†��j��)r‡��}rˆ��(h"U�h)}r‰��(h+]h,]h-]h.]h0]uh$jƒ��h ]rŠ��j„��)r‹��}rŒ��(h"Xƒ���DataObject
* Fields
* sysmeta
* databytes
* Constructors
* DataObject(Identifier, SystemMetadata, databytes)
* Methods
h$j‡��h%h&h'j‡��h)}r��(h+]h,]h-]h.]h0]uh2Kzh ]rŽ��(jŠ��)r��}r��(h"X
���DataObjectr‘��h$j‹��h%h&h'jŽ��h)}r’��(h+]h,]h-]h.]h0]uh2Kzh ]r“��h<X
���DataObjectr”��…r•��}r–��(h"j‘��h$j��ubaubj”��)r—��}r˜��(h"U�h)}r™��(h+]h,]h-]h.]h0]uh$j‹��h ]rš��h°)r›��}rœ��(h"U�h)}r��(hµX���*h.]h-]h+]h,]h0]uh$j—��h ]rž��(h·)rŸ��}r ��(h"X ���Fields
* sysmeta
* databytesh)}r¡��(h+]h,]h-]h.]h0]uh$j›��h ]r¢��j��)r£��}r¤��(h"U�h)}r¥��(h+]h,]h-]h.]h0]uh$jŸ��h ]r¦��j„��)r§��}r¨��(h"X ���Fields
* sysmeta
* databytesh$j£��h%h&h'j‡��h)}r©��(h+]h,]h-]h.]h0]uh2Kvh ]rª��(jŠ��)r«��}r¬��(h"X���Fieldsr��h$j§��h%h&h'jŽ��h)}r®��(h+]h,]h-]h.]h0]uh2Kvh ]r¯��h<X���Fieldsr°��…r±��}r²��(h"j��h$j«��ubaubj”��)r³��}r´��(h"U�h)}rµ��(h+]h,]h-]h.]h0]uh$j§��h ]r¶��h°)r·��}r¸��(h"U�h)}r¹��(hµX���*h.]h-]h+]h,]h0]uh$j³��h ]rº��(h·)r»��}r¼��(h"X���sysmetar½��h)}r¾��(h+]h,]h-]h.]h0]uh$j·��h ]r¿��hN)rÀ��}rÁ��(h"j½��h$j»��h%h&h'hQh)}rÂ��(h+]h,]h-]h.]h0]uh2Kvh ]rÃ��h<X���sysmetarÄ��…rÅ��}rÆ��(h"j½��h$jÀ��ubaubah'hºubh·)rÇ��}rÈ��(h"X ���databytesrÉ��h)}rÊ��(h+]h,]h-]h.]h0]uh$j·��h ]rË��hN)rÌ��}rÍ��(h"jÉ��h$jÇ��h%h&h'hQh)}rÎ��(h+]h,]h-]h.]h0]uh2Kwh ]rÏ��h<X ���databytesrÐ��…rÑ��}rÒ��(h"jÉ��h$jÌ��ubaubah'hºubeh'h³ubah'jé��ubeubah'jê��ubah'hºubh·)rÓ��}rÔ��(h"XB���Constructors
* DataObject(Identifier, SystemMetadata, databytes)h)}rÕ��(h+]h,]h-]h.]h0]uh$j›��h ]rÖ��j��)r×��}rØ��(h"U�h)}rÙ��(h+]h,]h-]h.]h0]uh$jÓ��h ]rÚ��j„��)rÛ��}rÜ��(h"X@���Constructors
* DataObject(Identifier, SystemMetadata, databytes)h$j×��h%h&h'j‡��h)}rÝ��(h+]h,]h-]h.]h0]uh2Kxh ]rÞ��(jŠ��)rß��}rà��(h"X ���Constructorsrá��h$jÛ��h%h&h'jŽ��h)}râ��(h+]h,]h-]h.]h0]uh2Kxh ]rã��h<X ���Constructorsrä��…rå��}ræ��(h"já��h$jß��ubaubj”��)rç��}rè��(h"U�h)}ré��(h+]h,]h-]h.]h0]uh$jÛ��h ]rê��h°)rë��}rì��(h"U�h)}rí��(hµX���*h.]h-]h+]h,]h0]uh$jç��h ]rî��h·)rï��}rð��(h"X1���DataObject(Identifier, SystemMetadata, databytes)rñ��h)}rò��(h+]h,]h-]h.]h0]uh$jë��h ]ró��hN)rô��}rõ��(h"jñ��h$jï��h%h&h'hQh)}rö��(h+]h,]h-]h.]h0]uh2Kyh ]r÷��h<X1���DataObject(Identifier, SystemMetadata, databytes)rø��…rù��}rú��(h"jñ��h$jô��ubaubah'hºubah'h³ubah'jé��ubeubah'jê��ubah'hºubh·)rû��}rü��(h"X���Methods
h)}rý��(h+]h,]h-]h.]h0]uh$j›��h ]rþ��hN)rÿ��}r���(h"X���Methodsr��h$jû��h%h&h'hQh)}r��(h+]h,]h-]h.]h0]uh2Kzh ]r��h<X���Methodsr��…r��}r��(h"j��h$jÿ��ubaubah'hºubeh'h³ubah'jé��ubeubah'jê��ubaubeubeubeubeubah"U�U transformerr��NU
footnote_refsr��}r ��Urefnamesr
��}r ��(X ���r project]r ��hXaX���cran]r
��(hxhÄeX���dataone r client package]r��hmauUsymbol_footnotesr��]r��Uautofootnote_refsr��]r��Usymbol_footnote_refsr��]r��U citationsr��]r��h3hU current_liner��NUtransform_messagesr��]r��Ureporterr��NUid_startr��KU
autofootnotesr ��]r ��U
citation_refsr ��}r ��Uindirect_targetsr ��]r!��Usettingsr"��(cdocutils.frontend
Values
r#��or$��}r%��(Ufootnote_backlinksr&��KUrecord_dependenciesr'��NU rfc_base_urlr(��U https://tools.ietf.org/html/r)��U tracebackr*��ˆUpep_referencesr+��NUstrip_commentsr,��NU
toc_backlinksr-��Uentryr.��U
language_coder/��Uenr0��U datestampr1��NU report_levelr2��KU _destinationr3��NU
halt_levelr4��KU
strip_classesr5��Nh9NU error_encoding_error_handlerr6��Ubackslashreplacer7��Udebugr8��NUembed_stylesheetr9��‰U output_encoding_error_handlerr:��Ustrictr;��U
sectnum_xformr<��KUdump_transformsr=��NU
docinfo_xformr>��KUwarning_streamr?��NUpep_file_url_templater@��Upep-%04drA��Uexit_status_levelrB��KUconfigrC��NUstrict_visitorrD��NUcloak_email_addressesrE��ˆU trim_footnote_reference_spacerF��‰UenvrG��NUdump_pseudo_xmlrH��NUexpose_internalsrI��NUsectsubtitle_xformrJ��‰U source_linkrK��NUrfc_referencesrL��NUoutput_encodingrM��Uutf-8rN��U
source_urlrO��NUinput_encodingrP��U utf-8-sigrQ��U_disable_configrR��NU id_prefixrS��U�U tab_widthrT��KUerror_encodingrU��UUTF-8rV��U_sourcerW��h&Ugettext_compactrX��ˆU generatorrY��NUdump_internalsrZ��NU smart_quotesr[��‰U pep_base_urlr\��U https://www.python.org/dev/peps/r]��Usyntax_highlightr^��Ulongr_��U input_encoding_error_handlerr`��j;��Uauto_id_prefixra��Uidrb��Udoctitle_xformrc��‰Ustrip_elements_with_classesrd��NU
_config_filesre��]rf��Ufile_insertion_enabledrg��ˆU raw_enabledrh��KU
dump_settingsri��NubUsymbol_footnote_startrj��K�Uidsrk��}rl��(hh—hjA��hh¢hh@h h hhhjO��uUsubstitution_namesrm��}rn��h'h3h)}ro��(h+]h.]h-]Usourceh&h,]h0]uU footnotesrp��]rq��Urefidsrr��}rs��ub.