Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve input column descriptions in manual #104

Open
hugomflavio opened this issue Oct 3, 2024 · 0 comments
Open

Improve input column descriptions in manual #104

hugomflavio opened this issue Oct 3, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@hugomflavio
Copy link
Owner

From Simon Dedman:

One thing I think could be really helpful would be to explain what each column IS, so that one understands what they're looking for, potentially from a mix of different columns.
You have this for most of them, but it might be good to be more explicit with CodeSpace (in Detections; "Code.space" in biometrics, concerningly), explaining that the original Transmitter string may typically consists of the CodeSpace ("A69-1008") followed by the Signal ("A69-1008-12345"). You could go further by suggesting relevant code tips for the users, e.g.

      dplyr::mutate(Timestamp = as.POSIXct(Date.and.Time..UTC.,
                                           format = "%Y-%m-%d %H:%M:%S",
                                           tz = "UTC"),  # "America/New_York"
                    Signal = as.numeric(stringr::str_sub(string = Transmitter,
                                                           start = 10,
                                                           end = -1)),
                    CodeSpace = stringr::str_sub(string = Transmitter,
                                                 start = 1,
                                                 end = 8),
                    Receiver = as.numeric(stringr::str_sub(string = Receiver,
                                                start = 6,
                                                end = -1))

It would be good to have explanations for detections$Sensor.Value & Sensor.Unit.

@hugomflavio hugomflavio added the documentation Improvements or additions to documentation label Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant