Permalink
Browse files

Fix documentation typos and minor build system config issues.

  • Loading branch information...
mbjones committed May 25, 2016
1 parent adcb70b commit cf4236c0b755087409a18bfdc5c6a3ef31e54b63
Showing with 10 additions and 9 deletions.
  1. +2 −0 .Rbuildignore
  2. +6 −6 R/AuthenticationManager.R
  3. +1 −1 dataone.Rproj
  4. +1 −2 vignettes/dataone-overview.Rmd
@@ -2,3 +2,5 @@
^\.Rproj\.user$
^\.travis.yml$
cran-comments.md
docker*
docker/*
@@ -23,13 +23,13 @@
#' when either a DataONE authentication token or X.509 Certificate is used.
#' @details
#' Understanding how your identity is managed is important for working with DataONE, especially to
#' avoid unexpected results. For example, depending your authorization status, searches may or may
#' avoid unexpected results. For example, depending your authorization status, searches may
#' return only public records, or the full set of public and private records. Object and package
#' retrievals might fail if some or all of the objects being retrieved are private. Creating or
#' updating objects on DataONE nodes and reserving identifiers reservations might fail if your
#' authorization certificate is missing or expired.
#' updating objects on DataONE nodes and reserving identifiers might fail if your
#' authorization credentials are missing or expired.
#'
#' DataONE identifies you using CILogon-provided x509 certificates. DataONE has
#' DataONE version 1.0 identifies you using CILogon-provided x509 certificates. DataONE has
#' partnered with CILogon to provide a widely-accessible certificate issuing mechanism
#' that allows DataONE users to use existing trusted institutional and public accounts.
#'
@@ -55,7 +55,7 @@
#' \item{\code{\link{getAuthMethod}}}{: Get the current valid authentication mechanism.}
#' \item{\code{\link{getAuthSubject}}}{: Get the authentication subject.}
#' \item{\code{\link{getAuthExpires}}}{: Get the expiration date of the current authentication method.}
#' \item{\code{\link{isAuthExpired}}}{: CHeck if the currently valid authentication method has reached the expiratin time.}
#' \item{\code{\link{isAuthExpired}}}{: Check if the currently valid authentication method has reached the expiration time.}
#' \item{\code{\link{obscureAuth}}}{: Temporarity disable DataONE authentication.}
#' \item{\code{\link{restoreAuth}}}{: Restore authentication (after being disabled with \code{obscureAuth}).}
#' \item{\code{\link{showAuth}}}{: Display all authentication information.}
@@ -231,7 +231,7 @@ setMethod("getAuthExpires", signature("AuthenticationManager"), function(.Object
authInfo <- evaluateAuth(.Object, node)
return(authInfo$expires)
})
#' CHeck if the currently valid authentication method has reached the expiratin time.
#' Check if the currently valid authentication method has reached the expiration time.
#' @rdname isAuthExpired
#' @aliases isAuthExpired
#' @param .Object An AuthenticationManager instance
@@ -6,7 +6,7 @@ AlwaysSaveHistory: Default

EnableCodeIndexing: Yes
UseSpacesForTab: Yes
NumSpacesForTab: 2
NumSpacesForTab: 4
Encoding: UTF-8

RnwWeave: knitr
@@ -54,8 +54,7 @@ For example, if the SID is specified when the object is downloaded, the most rec
### 2. New Authentication Mechanism
Uploading data to DataONE requires that a DataONE user identity be provided. In DataONE Version 1.x, the
identity of a user was provided by an X.509 client certificate. DataONE Version 2.0
adds an additional method to provide identity information - an *authentication token*, also refered to as
an identity code. Authentication tokens can be used with Member Nodes that have been upgraded to the DataONE Version 2.0 Member Node API.
adds an additional method to provide identity information - an *authentication token*. Authentication tokens can be used with Member Nodes that have been upgraded to the DataONE Version 2.0 Member Node API.

The process of providing user identity information either via an X.509 certificate or via an authentication token
is refered to as *authentication*.

0 comments on commit cf4236c

Please sign in to comment.