Use IDE Instances to Track Your Work

Whenever you have interesting data sets that are instrumental to addressing your research questions, you will want a track record that demonstrates how you arrived at this data, so that you or others can reproduce your findings. The IDE instances that are added to a study represent such a track record. 

Specifically, when you generate and save a visualization using an IDE, using the saveVisualization or saveDashApp methods, or when you commit new data files using the uploadFiles method, the IDE instance used is being recorded. This includes all aspects of that IDE instance, including the input data, the code, and the IDE image details. Saved IDE instances show up in the appropriately named section. 

Any authorized user can clone that IDE instance at a later time to deeper understand your finding and/or use this IDE as a starting point for further exploration.

When navigating a Study, you will notice an "IDE instances" tab. This tab will list all of the notebooks that uploaded data or Visualizations to your Study. To upload data or Visualizations to your Study, you can either use uploadFiles(), saveVisualization(), or save_dash_app() which will either save data, Visualizations, or a Plotly Dash app, respectively. In the screenshot below, note that the instances are separated between Visualization-related IDE and Files-related IDE depending on whether you are saving a Visualization or uploading a dataset.

Within the IDE instances tab, you are able to:

• Choose to clone the IDE, which will create an exact copy of the notebook that generated the output files.
• See what output files were generated for each listed entry under the "Output files'' column.
• Edit an IDE instance entry and attach a GitHub link if you desire.

Share IDE Instances

Whenever you have interesting data sets that are instrumental to addressing your research questions, you will want a track record that demonstrates how you arrived at this data, so that others can reproduce your findings. To help with this endeavor, we allow you  or other users to clone an IDE. The clone feature will copy the input data, the code, and the image details of the IDE. 

This clone feature is available any time you upload a result or a Visualization to a Study using uploadFiles(), saveVisualization(), or save_dash_app().  Once any of these function calls are successfully made, you will see an entry in the "IDE Instances" tab in the Study specified.