This vignette shows detailed examples for all functionalities of the
interactive_netrc()
function.
In order to connect to ImmuneSpace, you will need a
.netrc
file in your home directory that will contain a
machine
name (hostname of ImmuneSpace), and your
ImmuneSpace login
and password
. See here
for more information.
A netrc file may look like this:
machine datatools.immunespace.org
login myuser@domain.com
password supersecretpassword
There are two options when it comes to writing a netrc:
interactive_netrc
function.The interactive_netrc
function will:
Below is a gif demonstrating how to use this function:
In the case that the user did not provide login information that results in a connection to ImmuneSpace, a netrc file will not be written to the user’s home directory, and the user can try the method again checking for typos.
If the user still cannot connect to ImmuneSpace via the API, they might want to double check that they are registered and that their login information works for ImmuneSpace.
If a netrc file already exists, interactive_netrc
will
print the existing file to the console and ask the user if they wish to
overwrite that file.
Y
or y
will result in the same process as
if there were no netrc and overwrite the existing file.N
or n
will simply check if the existing
netrc is able to connect to ImmuneSpace. No new netrc file will be
created.Below is a gif demonstrating how this works: