Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jcolomb authored Jan 29, 2018
1 parent 81123da commit 3dd0c78
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# HCS_analysis
This code analyse data obtained from the homecagescan software (HCS, cleversys Inc.), it is buid to accept data from other single housed animal home cage monitoring systems.

As input, it uses the min summary file exported from the HCS and specific metadata files described in more detail in the "metadata_information" folder. (Attempt to use the raw data were not successful.) In brief, there are different metadata files:
As input, it uses the min or hour summary file exported from the HCS and specific metadata files described in more detail in the "metadata_information" folder. (Attempt to use the raw data are ongoing.) In brief, there are different metadata files:

- a project metadata: each project is listed in one spreadseets, path toward other metadata file is indicated there.
- a lab metadata: here is stocked information about the room where the experiment was performed (daily light cycle is indicated there).
- an experiment metadata: each row represent one test. Information about the animal tested is stored there.

# Adding data

Please refer to the metadata_information/Readme.md file. Once your data is in a format accepted by the software, you might upload it on github and archive it on zenodo. By indicating the folder as the raw data folder in github, the software can access the data directly on Github.
Please refer to https://github.com/jcolomb/HCS_analysis/blob/master/Metadata_information/Readme.md to create new metadata and modify your data to obtain a usable state. Once your data is in a format accepted by the software, you might upload it on github and archive it on zenodo, or keep it locally. By indicating the folder as the raw data folder in github, the software can access the data directly on Github.

We are using the osf to create a "repository" for the data (the master metadata file is hosted there because we can read and update it from R).

Expand Down

0 comments on commit 3dd0c78

Please sign in to comment.