Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wow-such-code committed Oct 23, 2024
1 parent 42670a2 commit d3085f6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,8 +323,12 @@ parameters need to be provided (there will be no references to existing study or
SEEK).

The script will try to find the provided **openbis ID** in experiments, samples or datasets and
fetch any missing information to create a folder structure containing at least one assay (when an
experiment without samples and datasets is specified).
fetch any missing information to create a folder structure in the provided **ro-path** containing at
least one assay's information (when an experiment without samples and datasets is specified).

Assets (files and their ISA metadata) are stored in a folder named like the openBIS dataset code
they are part of, which is either the subfolder of the experiment (assay), or the subfolder of a
sample, depending on where the dataset was attached in openBIS.

Info in the created asset .jsons always links back to the openBIS path of the respective dataset.
The data itself can be downloaded into the structure using the '-d' flag.
Expand Down Expand Up @@ -358,6 +362,7 @@ containing dataset codes (from openBIS) can be specified. //TODO do this for sam
Downloading dataset file to asset folder.
Writing asset json for file in dataset 20241021191109163-689109.
Downloading dataset file to asset folder.
...

**Creates structure:**

Expand Down
1 change: 0 additions & 1 deletion src/main/java/life/qbic/io/commandline/CreateROCrate.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
Expand Down

0 comments on commit d3085f6

Please sign in to comment.