[Example] README.txt
[Example] README.txt
Example of a README.txt file for a research dataset
README – Transcriptomic analysis of stimulated B cells (RNA-Seq)
Dataset title: Transcriptome_Bcells_Stimulation_2025
Author(s): Clara Dupont (clara.dupont@u-bordeaux.fr), supervised by Dr. Julien Morel
Affiliation: University of Bordeaux, Molecular Immunology Laboratory
Project: PROJECTACCRONYME – Grant Agreement 101XXXXX
Date created: 2025-06-01
Version: v1.0
Description: This dataset contains the results of an RNA-Seq analysis carried out on human B cells stimulated with cytokines. It includes:
raw sequencing files (FASTQ)
gene count tables (CSV)
R objects used for differential analysis (RData)
generated figures (.png, .pdf)
Repository structure:
/raw_data/ → compressed FASTQ files
/counts/ → normalised gene counts in .csv format
/analysis/ → R scripts, DESeq2 objects
/figures/ → final visualisations
/README.txt → this file
/metadata.txt → dataset metadata
Methods:
RNA extraction (TRIzol), quality control (Bioanalyzer), sequencing using Illumina NextSeq 550, bioinformatic pipeline FastQC → STAR → featureCounts, and differential expression analysis with DESeq2 (R v4.3).
Formats used: .fastq.gz, .csv, .RData, .pdf, .png
Required software: R (v4.3) with packages DESeq2, ggplot2; STAR; FastQC
Terms of use: The dataset is released under the CC BY 4.0 licence. Please cite the dataset and the European project when reusing the data.
Data repository: Zenodo – DOI: 10.5281/zenodo.1234567