Redivis Documentation
API DocumentationRedivis Home
  • Introduction
  • Redivis for open science
    • FAIR data practices
    • Open access
    • Data repository characteristics
    • Data retention policy
    • Citations
  • Guides
    • Getting started
    • Discover & access data
      • Discover datasets
      • Apply to access restricted data
      • Create a study
    • Analyze data in a workflow
      • Reshape data in transforms
      • Work with data in notebooks
      • Running ML workloads
      • Example workflows
        • Analyzing large tabular data
        • Create an image classification model
        • Fine tuning a Large Language Model (LLM)
        • No-code visualization
        • Continuous enrollment
        • Select first/last encounter
    • Export & publish your work
      • Export to other environments
      • Build your own site with Observable
    • Create & manage datasets
      • Create and populate a dataset
      • Upload tabular data as tables
      • Upload unstructured data as files
      • Cleaning tabular data
    • Administer an organization
      • Configure access systems
      • Grant access to data
      • Generate a report
      • Example tasks
        • Emailing subsets of members
    • Video guides
  • Reference
    • Your account
      • Creating an account
      • Managing logins
      • Single Sign-On (SSO)
      • Workspace
      • Studies
      • Compute credits and billing
    • Datasets
      • Documentation
      • Tables
      • Variables
      • Files
      • Creating & editing datasets
      • Uploading data
        • Tabular data
        • Geospatial data
        • Unstructured data
        • Metadata
        • Data sources
        • Programmatic uploads
      • Version control
      • Sampling
      • Exporting data
        • Download
        • Programmatic
        • Google Data Studio
        • Google Cloud Storage
        • Google BigQuery
        • Embedding tables
    • Workflows
      • Workflow concepts
      • Documentation
      • Data sources
      • Tables
      • Transforms
        • Transform concepts
        • Step: Aggregate
        • Step: Create variables
        • Step: Filter
        • Step: Join
        • Step: Limit
        • Step: Stack
        • Step: Order
        • Step: Pivot
        • Step: Rename
        • Step: Retype
        • Step: SQL query
        • Variable selection
        • Value lists
        • Optimization and errors
        • Variable creation methods
          • Common elements
          • Aggregate
          • Case (if/else)
          • Date
          • DateTime
          • Geography
          • JSON
          • Math
          • Navigation
          • Numbering
          • Other
          • Statistical
          • String
          • Time
      • Notebooks
        • Notebook concepts
        • Compute resources
        • Python notebooks
        • R notebooks
        • Stata notebooks
        • SAS notebooks
        • Using the Jupyter interface
      • Access and privacy
    • Data access
      • Access levels
      • Configuring access
      • Requesting access
      • Approving access
      • Usage rules
      • Data access in workflows
    • Organizations
      • Administrator panel
      • Members
      • Studies
      • Workflows
      • Datasets
      • Permission groups
      • Requirements
      • Reports
      • Logs
      • Billing
      • Settings and branding
        • Account
        • Public profile
        • Membership
        • Export environments
        • Advanced: DOI configuration
        • Advanced: Stata & SAS setup
        • Advanced: Data storage locations
        • Advanced: Data egress configuration
    • Institutions
      • Administrator panel
      • Organizations
      • Members
      • Datasets
      • Reports
      • Settings and branding
    • Quotas and limits
    • Glossary
  • Additional Resources
    • Events and press
    • API documentation
    • Redivis Labs
    • Office hours
    • Contact us
    • More information
      • Product updates
      • Roadmap
      • System status
      • Security
      • Feature requests
      • Report a bug
Powered by GitBook
On this page
  • Overview
  • Inspecting files
  • Folders and index tables
  • Working with files

Was this helpful?

Export as PDF
  1. Reference
  2. Datasets

Files

Last updated 5 months ago

Was this helpful?

Overview

Files are data entities uploaded to on Redivis. Files are used to store non-tabular (a.k.a. unstructured) data of any file type. You can view a dataset's files by clicking on the Files tab of any dataset or in a workflow.

Inspecting files

You can inspect an individual file by clicking on its name to launch the file viewer. Any file can be downloaded or referenced within a notebook, and many file types can be previewed directly within Redivis, including:

  • 3D models

  • Audio files

  • CIF + PDB files (molecular + protein structures)

  • FITS files (common in astronomy)

  • DICOM

  • HDF5

  • HTML

  • Images

  • PDFs

  • Videos

  • Text/code

  • TIFFs

  • ZIPs

  • TEI

Folders and index tables

All files are assigned to a "folder" within the dataset. You can click on the folder name in the right grey bar to filter this dataset's files by the folder they are in.

Each folder has a corresponding index table that is present on the Tables tab of the dataset. These will match the folder name and have a File index label.

In these index tables, each row of the table represents a file in that folder.

Variable name
Description

file_id

A unique, system generated identifier for the file. Use the file_id to reference and download specific file(s) in your analysis.

file_name

The name of the file

size

Size of the file in bytes

added_at

Timestamp for when the file was added to this folder

md5_hash

MD5 checksum of the file contents, encoded as a base64 string

Working with files

If you have a file type that you think should be supported that isn't, please !

You can view on the Redivis Demo organization.

By representing files within an index table, we can query and subset the files , while joining them with other tabular metadata. In this way, file index tables behave like any other tabular metadata on Redivis.

To do deeper analysis of files, we can for further analysis. Consult the documentation for your preferred programming language to learn more:

let us know
example files
within a workflow
load these files in a notebook
datasets
dataset node
View files in Redivis
Yes, Redivis supports cat images
Working with unstructured data files in R >
Working with unstructured data files in Python >