API

UniCell Deconvolve - Cell Type Deconvolution For Transcriptomic Data.

ucdeconvolve.api.activate(code: Optional[str] = None) None

Activate User Account

Activates account with an acitvation code recieved via email

Parameters:

code – Activation code emailed to user upon registration

Return type:

None

ucdeconvolve.api.authenticate(token: str) None

Authenticate

Updates user access token credentials

Parameters:

token – Valid user token

Return type:

None

ucdeconvolve.api.register(username: Optional[str] = None, password: Optional[str] = None, firstname: Optional[str] = None, lastname: Optional[str] = None, email: Optional[str] = None, institution: Optional[str] = None, dynamic: bool = True) None

Registers a New User

Parameters:
  • username – Username for new account

  • password – Password for new account

  • firstname – First name of new user

  • lastname – Last name of new user

  • email – Valid email address of new user. Note that an email will be sent for account activation.

  • institution – The insitution, academic or private, the user is affiliated with.

  • dynamic – Whether or not to prompt for inputs dynamically, default is True.

Return type:

Either nothing or waits for user to complete.