Working with workspaces
What is a workspace?
Workspaces are hosted private collaborative analytic environments within the AnalytiXagility platform, which a distributed team can access both through their web browser, and via virtual desktop environments. Workspaces provide a model for teams that may align to projects, programmes or working groups from one or more organisations or departments.
The core principles of a workspace are:
- Workspaces are private to their members.
- User access to workspace features and data is managed through a permissions model and can be maintained by a workspace administrator.
- Workspaces are configured based on file and database storage and compute requirements, virtual desktop requirements, and any additional add-on services (such as the RStudio Shiny server).
- Users manage their data in their AnalytiXagility workspace including modelling, cleansing, filtering and sharing.
- Workspaces manage core data assets such as database files and tables, documents and scripts (which we call files).
- Once uploaded, files, database and data files are readable and writable via both the web-interface and virtual desktop environment.
- Access is over secure network protocols to a suitably secure hosting environment at an Aridhia partner site.
- Workspaces provides audit reporting.
As already mentioned, each workspace contains files and links to datasets. When you first log into the platform you start on your “home” page, which is a list of all the workspaces you have access to.
Creating new workspace
You cannot directly create new workspaces: if you require a new workspace to be created, you must place a request with Aridhia’s administrator by emailing firstname.lastname@example.org.
Opening a workspace
To open a workspace, start on your homepage to see your workspace list, then click on either the workspace name or the associated folder icon in the workspace list. This takes you to the workspace Summary tab.
Getting access to a workspace
If there is a workspace that you are interested in viewing, but do not have access to, you can ask the workspace owner to invite you as a member of the workspace. Once they have done so you can accept the invitation from within the workspaces list by clicking on the Invited to join button, then the Respond to invite button.
Web-interface workspace functionality
Each web accessible workspace has the following functionality (please note that access to functionality is dependent on your role and access privileges. See the Role-based access section for more information):
- View a list of the workspaces of which they are members.
- View the activity stream for each workspace.
- Add insights, notes and tags within a workspace, with the option of notifying other users.
- Access files and shared scripts.
- Install packages into an R console session from a managed repository of libraries.
- Edit their profile (including contact details, description and profile image) and change their password.
- Run SQL queries on workspace data and view results.
- Access a ‘quick’ visualisation feature to create histograms, frequency tables, heat maps, time series plots and box plots.
- Search functions across data and files.
- Can be customised by adding/removing logos and adding a workspace description.
- Support an in-built R Console for interactive analysis.
- Have a file editor (SQL, R, RNW & Text).
- Have PDF report edit, creation and download capability.
- Allow resource tagging of workspaces, data and files.
- Support a ‘mini-apps’ visualisation and development environment (upgrade option).
- Support a dedicated R server configured according to specific memory and compute requirements for use with the R console (upgrade option).
The workspace Summary tab appears as follows:
A number of fixed tabs are visible from this page:
This tab shows a summary of recent activity relating to the workspace – for example when files have been uploaded or deleted. When on this page you can add notes, comments, and insights about any events in the workspace.
This tab shows all of the auditable events which have occurred in the workspace. These events include the user who have accessed the workspace and files being added or deleted. Additionally, some charts are shown which give a summary of different types of usage of the workspace over time.
This tab shows published R Shiny apps. You can also explore un-published mini-apps, explore mini-app file structure and add new files. You can also remove mini-apps from the gallery here.
This tab shows a list of the tables that are available in a database that have been associated with the workspace. Selecting the checkbox next to any of the listed tables will bring up details regarding the file type, number of columns and rows, related activity and size, in the panel on the right hand side of the window.
This tab shows all of the files associated with the workspace. These can be images, Word documents, PDFs, SQL/R scripts and custom files.
This tab gives access to an interactive R session. The R console is pre-configured with a broad selection of the most popular packages and can be easily configured to include any of the 5000+ packages that have been built by the R user community. These packages cover a wide variety of use cases from data manipulation and visualisation, to advanced analytics and machine learning, as well as specialist packages for text mining, natural language processing, genomics, clinical trials and imaging analysis.
The Add tab allows for the creation or uploading of new files. Also, any open file will appear as a new tab, making it easy to work with multiple files.
To contact support, send an email to the Aridhia service desk: email@example.com.
- What do I need to know?
- Working with workspaces
- Role-based access control
- Loading data into workspace
- Uploading data using the web interface
- Uploading data using SFTP
- Before you can upload data
- Preparing CSV files for uploading with SFTP
- The file name
- Contents of the CSV file
- Using table definition files with SFTP uploads
- The format of the table definition file
- The table definition element
- Data transformation during upload processes
- Working with data
- Working with files
- To upload files using SFTP
- To upload file-based data
- Creating a new file
- Adding and deleting files
- Downloading a file to your computer
- Opening, editing, and saving files
- Working with SQL files
- Working with R
- Working with LaTex markdown files .rnw
- Creating a report script
- Editing a report script
- Loading the ‘knitr’ library
- Generating a report from a script
- Viewing a generated report and optionally saving it to the workspace
- Making an image file available to a report script
- Working with mini-apps
- Enabling collaboration
- AirLock – managed data export and sharing
- Virtual desktop functionality
- Workspace snapshot
- Reviewing audit information