Package: CytobankAPI 2.2.1

Stu Blair

CytobankAPI: Cytobank API Wrapper for R

Tools to interface with Cytobank's API via R, organized by endpoints that represent various areas of Cytobank functionality. Learn more about Cytobank at <https://www.beckman.com/flow-cytometry/software>.

Authors:Stu Blair [aut, cre], Qihao Qi [aut], Stefanie Trop [aut], Louis Liu [aut], Preston Ng [aut], Chris Ciccolella [aut], Katherine Drake [aut]

CytobankAPI_2.2.1.tar.gz
CytobankAPI_2.2.1.tar.gz(r-4.5-noble)CytobankAPI_2.2.1.tar.gz(r-4.4-noble)
CytobankAPI_2.2.1.tgz(r-4.4-emscripten)CytobankAPI_2.2.1.tgz(r-4.3-emscripten)
CytobankAPI.pdf |CytobankAPI.html
CytobankAPI/json (API)
NEWS

# Install 'CytobankAPI' in R:
install.packages('CytobankAPI', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

This package does not link to any Github/Gitlab/R-forge repository. No issue tracker or development information is available.

3.79 score 61 scripts 791 downloads 131 exports 17 dependencies

Last updated 2 years agofrom:47512b9618. Checks:OK: 2. Indexed: yes.

TargetResultDate
Doc / VignettesOKDec 03 2024
R-4.5-linuxOKDec 03 2024

Exports:attachments.deleteattachments.downloadattachments.download_zipattachments.listattachments.showattachments.updateattachments.uploadauthenticateauthentication.logoutauthentication.revoke_all_tokensauthentication.revoke_all_tokens_userautogating.copy_autogating_analysis_settingsautogating.create_autogating_analysisautogating.delete_autogating_analysisautogating.list_autogating_analyses_of_typeautogating.rename_autogating_analysisautogating.run_autogating_analysisautogating.show_autogating_analysis_detailsautogating.show_autogating_analysis_statusautogating.update_autogating_inference_analysis_detailsautogating.update_autogating_training_analysis_detailscitrus.copy_settingscitrus.deletecitrus.downloadcitrus.listcitrus.newcitrus.renamecitrus.runcitrus.showcitrus.statuscitrus.updatecompensations.listcompensations.showcompensations.upload_csvCytobankAPI_newsdimensionality_reduction.copy_settingsdimensionality_reduction.deletedimensionality_reduction.listdimensionality_reduction.newdimensionality_reduction.renamedimensionality_reduction.rundimensionality_reduction.showdimensionality_reduction.statusdimensionality_reduction.updatedrop.uploadexperiments.clone_fullexperiments.clone_selectiveexperiments.deleteexperiments.full_access_users_addexperiments.full_access_users_listexperiments.full_access_users_removeexperiments.listexperiments.newexperiments.showexperiments.trashexperiments.updatefcs_files.downloadfcs_files.download_zipfcs_files.file_internal_comp_showfcs_files.listfcs_files.showfcs_files.statusfcs_files.uploadfcs_files.upload_zipflowsom.copy_settingsflowsom.deleteflowsom.downloadflowsom.listflowsom.newflowsom.renameflowsom.runflowsom.showflowsom.statusflowsom.updategates.applygates.gatingML_downloadgates.gatingML_uploadgates.listgates.showhelper.channel_ids_from_long_nameshelper.filter_names_to_ids_from_dfpanels.listpanels.showpeacoqc.copy_settingspeacoqc.listpeacoqc.newpeacoqc.renamepeacoqc.runpeacoqc.showpeacoqc.statuspeacoqc.updatepopulations.listpopulations.showsample_tags.downloadsample_tags.uploadscales.listscales.showscales.updatespade.bubbles_exportspade.bubbles_setspade.bubbles_showspade.copy_resultsspade.copy_settingsspade.deletespade.download_allspade.download_clusters_tablespade.download_global_boundaries_tablespade.download_gmlspade.download_layout_tablespade.download_statistics_tablesspade.listspade.newspade.renamespade.runspade.showspade.statusspade.updatestatistics.event_countsstatistics.generalusers.listusers.showvisne.copy_settingsvisne.deletevisne.helper.set_populationsvisne.listvisne.newvisne.renamevisne.runvisne.showvisne.statusvisne.update

Dependencies:askpassaws.s3aws.signaturebase64encclicurldigesthttrjosejsonlitemimeopensslR6rlangsysuuidxml2

CytobankAPI advanced analysis guide

Rendered fromcytobank-advanced-analyses.Rmdusingknitr::rmarkdownon Dec 03 2024.

Last update: 2022-03-31
Started: 2017-01-12

CytobankAPI quickstart guide

Rendered fromcytobank-quickstart.Rmdusingknitr::rmarkdownon Dec 03 2024.

Last update: 2022-03-31
Started: 2017-01-12

Readme and manuals

Help Manual

Help pageTopics
S4 Advanced Analysis ClassAdvancedAnalysis-class
Attachment Endpointsattachments attachments.delete attachments.delete,UserSession-method attachments.download attachments.download,UserSession-method attachments.download_zip attachments.download_zip,UserSession-method attachments.list attachments.list,UserSession-method attachments.show attachments.show,UserSession-method attachments.update attachments.update,UserSession-method attachments.upload attachments.upload,UserSession-method
Authentication Endpointsauthenticate authentication authentication.logout authentication.logout,UserSession-method authentication.revoke_all_tokens authentication.revoke_all_tokens,UserSession-method authentication.revoke_all_tokens_user authentication.revoke_all_tokens_user,UserSession-method
Automatic gating Endpointsautogating autogating.copy_autogating_analysis_settings autogating.copy_autogating_analysis_settings,UserSession-method autogating.create_autogating_analysis autogating.create_autogating_analysis,UserSession-method autogating.delete_autogating_analysis autogating.delete_autogating_analysis,UserSession-method autogating.list_autogating_analyses_of_type autogating.list_autogating_analyses_of_type,UserSession-method autogating.rename_autogating_analysis autogating.rename_autogating_analysis,UserSession-method autogating.run_autogating_analysis autogating.run_autogating_analysis,UserSession-method autogating.show_autogating_analysis_details autogating.show_autogating_analysis_details,UserSession-method autogating.show_autogating_analysis_status autogating.show_autogating_analysis_status,UserSession-method autogating.update_autogating_inference_analysis_details autogating.update_autogating_inference_analysis_details,UserSession-method autogating.update_autogating_training_analysis_details autogating.update_autogating_training_analysis_details,UserSession-method
CITRUS Endpointscitrus citrus.copy_settings citrus.copy_settings,UserSession,CITRUS-method citrus.delete citrus.delete,UserSession,CITRUS-method citrus.download citrus.download,UserSession,CITRUS-method citrus.list citrus.list,UserSession-method citrus.new citrus.new,UserSession-method citrus.rename citrus.rename,UserSession,CITRUS-method citrus.run citrus.run,UserSession,CITRUS-method citrus.show citrus.show,UserSession-method citrus.status citrus.status,UserSession,CITRUS-method citrus.update citrus.update,UserSession,CITRUS-method
S4 CITRUS ClassCITRUS-class
Compensation Endpointscompensations compensations.list compensations.list,UserSession-method compensations.show compensations.show,UserSession-method compensations.upload_csv compensations.upload_csv,UserSession-method
DimensionalityReduction Endpointsdimensionality_reduction dimensionality_reduction.copy_settings dimensionality_reduction.copy_settings,UserSession,DimensionalityReduction-method dimensionality_reduction.delete dimensionality_reduction.delete,UserSession,DimensionalityReduction-method dimensionality_reduction.list dimensionality_reduction.list,UserSession-method dimensionality_reduction.new dimensionality_reduction.new,UserSession-method dimensionality_reduction.rename dimensionality_reduction.rename,UserSession,DimensionalityReduction-method dimensionality_reduction.run dimensionality_reduction.run,UserSession,DimensionalityReduction-method dimensionality_reduction.show dimensionality_reduction.show,UserSession-method dimensionality_reduction.status dimensionality_reduction.status,UserSession,DimensionalityReduction-method dimensionality_reduction.update dimensionality_reduction.update,UserSession,DimensionalityReduction-method
S4 DimensionalityReduction ClassDimensionalityReduction-class
DROP File Endpointsdrop drop.upload drop.upload,UserSession-method
Experiment Endpointsexperiments experiments.clone_full experiments.clone_full,UserSession-method experiments.clone_selective experiments.clone_selective,UserSession-method experiments.delete experiments.delete,UserSession-method experiments.full_access_users_add experiments.full_access_users_add,UserSession-method experiments.full_access_users_list experiments.full_access_users_list,UserSession-method experiments.full_access_users_remove experiments.full_access_users_remove,UserSession-method experiments.list experiments.list,UserSession-method experiments.new experiments.new,UserSession-method experiments.show experiments.show,UserSession-method experiments.trash experiments.trash,UserSession-method experiments.update experiments.update,UserSession-method
FCS File Endpointsfcs_files fcs_files.download fcs_files.download,UserSession-method fcs_files.download_zip fcs_files.download_zip,UserSession-method fcs_files.file_internal_comp_show fcs_files.file_internal_comp_show,UserSession-method fcs_files.list fcs_files.list,UserSession-method fcs_files.show fcs_files.show,UserSession-method fcs_files.status fcs_files.status,UserSession-method fcs_files.upload fcs_files.upload,UserSession-method fcs_files.upload_zip fcs_files.upload_zip,UserSession-method
FlowSOM Endpointsflowsom flowsom.copy_settings flowsom.copy_settings,UserSession,FlowSOM-method flowsom.delete flowsom.delete,UserSession,FlowSOM-method flowsom.download flowsom.download,UserSession,FlowSOM-method flowsom.list flowsom.list,UserSession-method flowsom.new flowsom.new,UserSession-method flowsom.rename flowsom.rename,UserSession,FlowSOM-method flowsom.run flowsom.run,UserSession,FlowSOM-method flowsom.show flowsom.show,UserSession-method flowsom.status flowsom.status,UserSession,FlowSOM-method flowsom.update flowsom.update,UserSession,FlowSOM-method
S4 FlowSOM ClassFlowSOM-class
Gate Endpointsgates gates.apply gates.apply,UserSession-method gates.gatingML_download gates.gatingML_download,UserSession-method gates.gatingML_upload gates.gatingML_upload,UserSession-method gates.list gates.list,UserSession-method gates.show gates.show,UserSession-method
Helper Functionshelper.channel_ids_from_long_names helper.filter_names_to_ids_from_df helper_functions
NewsCytobankAPI_news news
S4 opt-SNE ClassoptSNE-class
Panel Endpointspanels panels.list panels.list,UserSession-method panels.show panels.show,UserSession-method
PeacoQC Endpointspeacoqc peacoqc.copy_settings peacoqc.copy_settings,UserSession,PeacoQC-method peacoqc.list peacoqc.list,UserSession-method peacoqc.new peacoqc.new,UserSession-method peacoqc.rename peacoqc.rename,UserSession,PeacoQC-method peacoqc.run peacoqc.run,UserSession,PeacoQC-method peacoqc.show peacoqc.show,UserSession-method peacoqc.status peacoqc.status,UserSession,PeacoQC-method peacoqc.update peacoqc.update,UserSession,PeacoQC-method
S4 PeacoQC ClassPeacoQC-class
Population Endpointspopulations populations.list populations.list,UserSession-method populations.show populations.show,UserSession-method
Sample Tag Endpointssample_tags sample_tags.download sample_tags.download,UserSession-method sample_tags.upload sample_tags.upload,UserSession-method
Scale Endpointsscales scales.list scales.list,UserSession-method scales.show scales.show,UserSession-method scales.update scales.update,UserSession-method
SPADE Endpointsspade spade.bubbles_export spade.bubbles_export,UserSession,SPADE-method spade.bubbles_set spade.bubbles_set,UserSession,SPADE-method spade.bubbles_show spade.bubbles_show,UserSession,SPADE-method spade.copy_results spade.copy_results,UserSession,SPADE-method spade.copy_settings spade.copy_settings,UserSession,SPADE-method spade.delete spade.delete,UserSession,SPADE-method spade.download_all spade.download_all,UserSession,SPADE-method spade.download_clusters_table spade.download_clusters_table,UserSession,SPADE-method spade.download_global_boundaries_table spade.download_global_boundaries_table,UserSession,SPADE-method spade.download_gml spade.download_gml,UserSession,SPADE-method spade.download_layout_table spade.download_layout_table,UserSession,SPADE-method spade.download_statistics_tables spade.download_statistics_tables,UserSession,SPADE-method spade.list spade.list,UserSession-method spade.new spade.new,UserSession-method spade.rename spade.rename,UserSession,SPADE-method spade.run spade.run,UserSession,SPADE-method spade.show spade.show,UserSession-method spade.status spade.status,UserSession,SPADE-method spade.update spade.update,UserSession,SPADE-method
S4 SPADE ClassSPADE-class
Statistic Endpointsstatistics statistics.event_counts statistics.event_counts,UserSession-method statistics.general statistics.general,UserSession-method
S4 tSNE ClasstSNE-class
S4 UMAP ClassUMAP-class
User Endpointsusers users.list users.list,UserSession-method users.show users.show,UserSession-method
S4 Cytobank UserSession ClassUserSession-class
viSNE Endpointsvisne visne.copy_settings visne.copy_settings,UserSession,viSNE-method visne.delete visne.delete,UserSession,viSNE-method visne.helper.set_populations visne.list visne.list,UserSession-method visne.new visne.new,UserSession-method visne.rename visne.rename,UserSession,viSNE-method visne.run visne.run,UserSession,viSNE-method visne.show visne.show,UserSession-method visne.status visne.status,UserSession,viSNE-method visne.update visne.update,UserSession,viSNE-method
S4 viSNE ClassviSNE-class