Update README.md

README.md

@@ -7,4 +7,33 @@ language:
 pretty_name: cran-packages
 size_categories:
 - 100K<n<1M
----
+---
+
+## CRAN packages dataset
+
+R and Rmd source codes for CRAN packages. 
+
+The dataset has been constructed using the following steps:
+
+- Downloaded latest version from all packages on CRAN (see last updated). The source code has been downloaded from the [GitHub mirror](https://github.com/cran).
+- Identified the licenses from each package from their DESCRIPTION file, and classified each of them into some license_code. See the licenses.csv file.
+- Extract R and Rmd source files from packages identified with permissive licenses (following the same list from [The Stack dataset](https://huggingface.co/datasets/bigcode/the-stack))
+
+Datasets are provided as parquet files containing the following columns:
+
+```
+FileSystemDataset with 2 Parquet files
+126,478 rows x 9 columns
+$ filename <string> "cran-devtools-945c660/R/R.R", "cran-devtools-945c660/R/active.R"…
+$ compressed_size <double> 622, 601, 142, 428, 895, 455, 1365, 740, 329, 955, 1689, 3132, 24…
+$ uncompressed_size <double> 1099, 1385, 179, 715, 2024, 907, 3564, 1843, 664, 2096, 4696, 858…
+$ timestamp <timestamp[us, tz=UTC]> 2022-10-11 07:12:36, 2022-10-11 07:12:36, 2022-10-11 07:12:36, 20…
+$ permissions <ext<octmode>> 600, 600, 600, 600, 600, 600, 600, 600, 600, 600, 600, 600, 600, …
+$ crc32 <ext<hexmode>> 6aafc73e, 6c7082a5, b1fdeb73, 8f6a4e25, 16941e78, bdd4943b, 6d0a1…
+$ offset <double> 39452, 40140, 40812, 41023, 41528, 42500, 43030, 44474, 45288, 45…
+$ package <string> "devtools", "devtools", "devtools", "devtools", "devtools", "devt…
+$ content <string> "#' Environment variables to set when calling R\n#'\n#' Devtools …
+Call `print()` for full schema details
+```
+
+Last updated: Jun 2th 2023