man.opencgaLogin.Rd Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of opencga-client Show documentation

The newest version!

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/OpencgaR-methods.R
\name{opencgaLogin}
\alias{opencgaLogin}
\alias{OpencgaLogin}
\title{Login to OpenCGA Web Services}
\usage{
opencgaLogin(
  opencga,
  userid = NULL,
  passwd = NULL,
  interactive = FALSE,
  autoRenew = FALSE,
  verbose = FALSE,
  showToken = FALSE
)
}
\arguments{
\item{userid}{a charatcer with the username}

\item{passwd}{a charcter with the user password
#@param version a character with the OpenCGA version to use}

\item{interactive}{whether to launch a graphical interface, FALSE by default
#@param ... Any other arguments}

\item{ocga}{an object of type OpencgaR generated using initOpencgaR}
}
\value{
an Opencga class object

\dontrun{
con <- initOpencgaR(host = "http://bioinfo.hpc.cam.ac.uk/opencga-prod/", version = "v2")
con <- opencgaLogin(opencga = con, userid = "demouser", passwd = "demouser", showToken = TRUE)

# Configuration in list format
conf <- list(version="v2", rest=list(host="http://bioinfo.hpc.cam.ac.uk/opencga-prod/"))
con <- initOpencgaR(opencgaConfig=conf)
con <- opencgaLogin(opencga = con, userid = "demouser", passwd = demouser")

# Configuration in file format ("YAML" or "JSON")
conf <- "/path/to/conf/client-configuration.yml"
con <- initOpencgaR(opencgaConfig=conf)
con <- opencgaLogin(opencga = con, userid = "demouser", passwd = "demouser")
}
}
\description{
A function to login Opencga web services
}