populations | R Documentation |
Interact with population (aka gate sets) endpoints. A population is a set of gates and can have parents and children. Learn more about gates and populations.
## S4 method for signature 'UserSession'
populations.list(
UserSession,
experiment_id,
output = "default",
timeout = UserSession@short_timeout
)
## S4 method for signature 'UserSession'
populations.show(
UserSession,
experiment_id,
population_id,
output = "default",
timeout = UserSession@short_timeout
)
UserSession |
Cytobank UserSession object |
experiment_id |
integer representing an experiment ID |
output |
character representing the output format [optional] |
timeout |
integer representing the request timeout time in seconds |
population_id |
integer representing a population ID |
populations.list
List all populations from an experiment. Outputs a dataframe [default] or raw list with all fields present.
- Optional output parameter, specify one of the following: ("default", "raw")
populations.show
Show population details from an experiment.
- Optional output parameter, specify one of the following: ("default", "raw")
## Not run: # Authenticate via username/password
cyto_session <- authenticate(site="premium", username="cyril_cytometry", password="cytobank_rocks!")
# Authenticate via auth_token
cyto_session <- authenticate(site="premium", auth_token="my_secret_auth_token")
## End(Not run)
## Not run: # Dataframe of all populations with all fields present
populations.list(cyto_session, 22)
# Raw list of all populations with all fields present
populations.list(cyto_session, 22, output="raw")
## End(Not run)
## Not run: populations.show(cyto_session, 22, population_id=2)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.