From 09abadb699515d0c8ce2450b23c119e38fbac010 Mon Sep 17 00:00:00 2001 From: Stuart Wheater Date: Wed, 27 Feb 2019 12:18:15 +0000 Subject: [PATCH] Update documents, and version --- DESCRIPTION | 3 ++- man/findLoginObjects.Rd | 24 +++++++++++++++--------- man/getOpals.Rd | 14 ++++++-------- 3 files changed, 23 insertions(+), 18 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index b419490..714f996 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,10 +1,11 @@ Package: dsStatsClient Maintainer: Author: -Version: 4.1.1 +Version: 4.1.2 License: GPL-3 Title: DataSHIELD client site stattistical functions Description: DataSHIELD client site stattistical functions Depends: opal, dsBaseClient +RoxygenNote: 6.1.1 diff --git a/man/findLoginObjects.Rd b/man/findLoginObjects.Rd index 5062bb3..710eab1 100644 --- a/man/findLoginObjects.Rd +++ b/man/findLoginObjects.Rd @@ -1,3 +1,5 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/findLoginObjects.R \name{findLoginObjects} \alias{findLoginObjects} \title{searches for opal login object in the environment} @@ -11,16 +13,20 @@ returns a list of opal login objects or stops the process This is an internal function required by a client function } \details{ - - -if the user does not set the argument 'datasources', this -function is called to searches for opal login objects in -the environment. If more than one login object is found a -prompt asks the user to choose one and if none is found the -process stops. +if the user does not set the argument 'datasources', this function +is called to searches for opal login objects in the environment. +If only one opal object is found, it automatically becomes the default selection. +If more than one is found but one is called 'default.opals' then that is selected. +If more than one is found with none is called 'default.opals' the user is +told that they can either specify a particular Opal using the 'datasources=' argument +that exists in every relevant datashield client-side function or else they +can use the 'ds.setDefaultOpals()' function to create a copy of a selected Opal objects +which is called 'default.opals' and is then selected by default in future calls to findLoginObjects. +If the default Opal object needs to be changed then 'ds.setDefaultOpals()' can be run again. +A previous version of 'findLoginObjects()' asked the user to specify which Opal to choose +if no default could be identified, but that did not work in all versions of R and so was removed. } \author{ -Gaye, A. +Amadou Gaye, Paul Burton (updated 15/10/18). THIS IS VERSION TO USE 8/2/19. } \keyword{internal} - diff --git a/man/getOpals.Rd b/man/getOpals.Rd index d033aa2..1cc1b2e 100644 --- a/man/getOpals.Rd +++ b/man/getOpals.Rd @@ -1,3 +1,5 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/getOpals.R \name{getOpals} \alias{getOpals} \title{Gets the opal objects} @@ -11,15 +13,11 @@ a list of opal object obtained after login into the servers This is an internal function. } \details{ - - -The function searches for a list containing object of type -'opal' in the global environment; if more than one list is -found it return the lastest. This way no matter what the -user calls his opal login object it will be captured. +The function searches for a list containing object of type 'opal' +in the global environment; if more than one list is found it return the lastest. +This way no matter what the user calls his opal login object it will be captured. } \author{ -Gaye,A. +Amadou Gaye, Paul Burton (updated 15/10/18). THIS IS VERSION TO USE 8/2/19. } \keyword{internal} -