File tree 1 file changed +8
-2
lines changed
scripts/refcodes_with_properties
1 file changed +8
-2
lines changed Original file line number Diff line number Diff line change 1
1
# Refcode List Generator
2
2
3
3
## Summary
4
+
4
5
A script that allows you to create refcode lists (or CSV files of properties for a refcode list) for simple properties. The advantage of the script is
5
6
that the control is via an easy to read file so you can keep an interprettable record of how a test set was generated in research. You can also then
6
7
reproduce the list, or indeed run it on a new database and update it with the same conditions.
7
8
8
9
### Relevance
10
+
9
11
We want research to be FAIR (Findable, Attributable, Interoperable and Reproducible) - this script means we can create a simple decscription of the
10
12
test set used that any researcher could then reproduce from the script and the description.
11
13
@@ -20,14 +22,18 @@ test set used that any researcher could then reproduce from the script and the d
20
22
- CSD-Core
21
23
22
24
## Instructions on Running
25
+
23
26
### Linux command line
27
+
24
28
- load the CSD Python API Miniconda environment
25
29
- create a text control file with the various control lines specified
26
30
- call Python to read the script and specify necessary arguments
31
+
27
32
~~~
28
- $ python refcodes_with_properties.py --help
33
+ python refcodes_with_properties.py --help
29
34
~~~
30
- The above will print an extended help message that describes the registered
35
+
36
+ The above will print an extended help message that describes the registered
31
37
32
38
You can run the script with an Example file. Results are printed by default and can be redirected to be saved in an output file, e.g.
33
39
~~~
You can’t perform that action at this time.
0 commit comments