Skip to content

Commit 235b714

Browse files
authored
Create README.md
references #16
1 parent b54b4e0 commit 235b714

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# ISADotNet
2+
ISA compliant experimental metadata toolkit in F#
3+
4+
The library contains types and functionality for creating and working on experimental metadata in ISA format.
5+
Additionally, the types can easily be written to and read from `Json` files in [ISAJson format](https://isa-specs.readthedocs.io/en/latest/isajson.html) and Microsoft `Excel` files in [ISATab format](https://isa-specs.readthedocs.io/en/latest/isatab.html).
6+
7+
8+
9+
# Installation
10+
11+
The `ISADotNet` nuget package can be found [here](https://www.nuget.org/packages/ISADotNet/)
12+
13+
The `ISADotNet.XLSX` nuget package can be found [here](https://www.nuget.org/packages/ISADotNet.XLSX/)
14+
15+
Adding a package reference via dotnet:
16+
`dotnet add package ISADotNet --version 0.1.0`
17+
18+
Adding a package reference in F# interactive:
19+
`#r "nuget: ISADotNet, 0.1.0"`
20+
21+
# What is ISA?
22+
23+
ISA is a specification for annotation of research data. The metadata in nested in three different layers: <b>I</b>nvestigation, <b>S</b>tudy and <b>A</b>ssay.
24+
25+
Around these three main entities, the following abstract datamodel is specified:
26+
27+
![Abstract Datamodel](https://isa-specs.readthedocs.io/en/latest/_images/isa_model_1_ccoded.png)
28+
Source: https://isa-specs.readthedocs.io/en/latest/_images/isa_model_1_ccoded.png
29+
30+
Additional Info: https://isa-specs.readthedocs.io/en/latest/isamodel.html
31+
32+
# Usage
33+

0 commit comments

Comments
 (0)