Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Illustratien committed Dec 11, 2023
1 parent 1acc736 commit a7b71d7
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 3 deletions.
9 changes: 8 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,14 @@ For those picture that is both manually labelled and detected by the `NTU`
1. run [`check_ntu.R`](https://github.com/Illustratien/Stomata/blob/main/src/modules/clean_ntu.R) from line 38-40 to validate the detected data with ground truth
* note that only picture with the same picture name as ground truth when the detected stomata center is 3.2 microm to the ground truth.


## Pull request
Want to contribute to the code? Very welcome!

1. copy the script that you want to modified in 'src/test'
2. modified the code
3. test if there is error
4. move it to the original folder and overwrite
5. make a pull request


## ❓ Issues/Problems/Errors
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ For those picture that is both manually labelled and detected by the
- note that only picture with the same picture name as ground truth when
the detected stomata center is 3.2 microm to the ground truth.

## Pull request

Want to contribute to the code? Very welcome!

1. copy the script that you want to modified in ‘src/test’
2. modified the code
3. test if there is error
4. move it to the original folder and overwrite
5. make a pull request

## ❓ Issues/Problems/Errors

Please raise your question in
Expand Down
4 changes: 2 additions & 2 deletions src/run.R
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# install required packages
source("src/modules/set_up.R")
# project folder structure-------------------------------------------------------------------------
# put folders contains only .xml under "data"
# each folder is one batch of experiment
# put folders contains only .xml under "data", each folder is one batch of experiment
dir.create(file.path("./src/test"), showWarnings = FALSE)
dir.create(file.path("./data"), showWarnings = FALSE)
dir.create(file.path("./result"), showWarnings = FALSE)
# read files-------------------------------------------------------------------------
Expand Down

0 comments on commit a7b71d7

Please sign in to comment.