Skip to content

Commit d778a1e

Browse files
Apply flake automatic blank link suggestions from code review (NO_JIRA)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 96cb731 commit d778a1e

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

scripts/refcodes_with_properties/ReadMe.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Refcode List Generator
22

33
## Summary
4+
45
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
56
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
67
reproduce the list, or indeed run it on a new database and update it with the same conditions.
78

89
### Relevance
10+
911
We want research to be FAIR (Findable, Attributable, Interoperable and Reproducible) - this script means we can create a simple decscription of the
1012
test set used that any researcher could then reproduce from the script and the description.
1113

@@ -20,14 +22,18 @@ test set used that any researcher could then reproduce from the script and the d
2022
- CSD-Core
2123

2224
## Instructions on Running
25+
2326
### Linux command line
27+
2428
- load the CSD Python API Miniconda environment
2529
- create a text control file with the various control lines specified
2630
- call Python to read the script and specify necessary arguments
31+
2732
~~~
28-
$ python refcodes_with_properties.py --help
33+
python refcodes_with_properties.py --help
2934
~~~
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
3137

3238
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.
3339
~~~

0 commit comments

Comments
 (0)