Update README.md

README.md

@@ -1,8 +1,16 @@
-<h1>Raw Data Source</h1>
+<h1>2J-Protein-Coupling Dataset</h1>
+
+This data set was curated from the papers below accessed through the Biological Magnetic Resonance Data Bank (BMRB). There are a total of 3999 2J coupling taken from 5 different proteins and up to 10 different experiments. This dataset contains information regarding PDB ID, Sequence, 2J coupling data of 15N, 13C, and 1H. Data was curated and organized into this set of the five papers below, with the addition of the sequence taken from the Protein Data Bank.
+
+
+<h2>Raw Data Source</h2>
+<p>This dataset was curated from the following research papers:</p>
+<ul>
 
 <p> Input Paper 1</p>
 <p> DOI </p>
 
+
 <p> Input Paper 2</p>
 <p> DOI </p>
 
@@ -13,4 +21,49 @@
 <p> DOI </p>
 
 <p> Input Paper 5</p>
-<p> DOI </p>
+<p> DOI </p>
+
+</ul>
+
+<h2>Quickstart Usage</h2>
+
+<h3>1. Install the datasets Library</h3>
+<p>From the terminal / command line:</p>
+<pre><code>pip install datasets
+</code></pre>
+
+<p>In Jupyter Notebook, prefix with <code>!</code>:</p>
+<pre><code>!pip install datasets
+</code></pre>
+
+<h3>2. Load the Dataset in Python</h3>
+<pre><code>from datasets import load_dataset
+
+dataset_protein = load_dataset(
+    "nlangdon/2J-Protein-Coupling",
+    data_files="Protein/*.csv"
+)
+</code></pre>
+
+<h3>3. Access Dataset Columns</h3>
+<pre><code># Example: Get protein sequences and lengths
+sequences = dataset_protein["train"]["sequence"]
+lengths = dataset_protein["train"]["sequence_length"]
+
+print(sequences[:5])
+print(lengths[:5])
+</code></pre>
+
+<h2>Dataset Description</h2>
+<p>Each row represents a single polymer chain within a larger macromolecular assembly. Key fields include:</p>
+<ul>
+  <li><strong>entry_id</strong>: ID from the Biological Magnetic Resonance Data Bank (BMRB)</li>
+  <li><strong>file_name</strong>: Named by experiment and entry_id</li>
+  <li><strong>sequence_length</strong>: Length of the protein sequence</li>
+  <li><strong>sequence</strong>: Protein sequence in single-letter amino acid code</li>
+  <li><strong>experiment_code</strong>: Type of experiment</li>
+  <li><strong>num_measurements</strong>: Number of experiments recorded for each protein</li>
+</ul>
+
+
+<i>_This dataset was curated by Nicolas Langdon (<a href="mailto:nblangdon@wesleyan.edu">nblangdon@wesleyan.edu</a>) from the five original papers listed above._</i>