search

JMSLab / LaroplanOCR

Swedish primary school curricula (Läroplaner för grundskolan) in digital format.
MIT License
2 stars 0 forks source link

Pull request for #4: Construct example on how to use data #5

Closed santiagohermo closed 2 years ago

santiagohermo commented 2 years ago

Can you review this PR for #4 @jmshapir @miikapaal? We are adding an example on how to use the data.

Some details on the structure are in https://github.com/JMSLab/LaroplanOCR/issues/4#issuecomment-1026458829

jmshapir commented 2 years ago

Thanks @miikapaal!

I made some small edits that I wanted to push to the repo, but I forgot I don't yet have write access! @jmshapir or @santiagohermo could you fix this? Thanks!

Done!

I agree with the plan @jmshapir suggested in #4 (comment). Perhaps we could also open a separate issue for sketching a documentation PDF at the same time? I and @santiagohermo could perhaps produce an initial version of the document.

Would the additional documentation be for the purpose of submitting a data archive to ICPSR/Dataverse/etc.? If so we might want to first understand what are their minimal requirements for archiving. The closer we can get to just uploading a snapshot of this repository, the lower it seems like the maintenance cost will be going forward.

miikapaal commented 2 years ago

Thanks @miikapaal!

I made some small edits that I wanted to push to the repo, but I forgot I don't yet have write access! @jmshapir or @santiagohermo could you fix this? Thanks!

Done!

Great, thank you @jmshapir. My edits are in https://github.com/JMSLab/LaroplanOCR/pull/5/commits/65bf7490d2ca7ab3009c0127b2bb4cafd38684b7. FYI @santiagohermo

I agree with the plan @jmshapir suggested in #4 (comment). Perhaps we could also open a separate issue for sketching a documentation PDF at the same time? I and @santiagohermo could perhaps produce an initial version of the document.

Would the additional documentation be for the purpose of submitting a data archive to ICPSR/Dataverse/etc.? If so we might want to first understand what are their minimal requirements for archiving. The closer we can get to just uploading a snapshot of this repository, the lower it seems like the maintenance cost will be going forward.

I was thinking of writing up a very short document that discusses what kinds of documents the Läroplan docs are, describes in words our approach for arriving at the word count files, and describes briefly both the illustrative example in this repo and the two figures in the Skills paper that are based on the Läroplan docs. We could include the PDF if we submit a data archive to ICPSR/Dataverse/etc.

But you may be right that such a PDF might be unnecessary and that just the READMEs in the repo are enough. I'm fine with postponing this until we're closer to making these materials public.

santiagohermo commented 2 years ago

Thanks @miikapaal @jmshapir!

santiagohermo commented 2 years ago

Summary here

jmshapir commented 2 years ago

@santiagohermo @miikapaal thanks both!

@miikapaal regarding documentation that makes sense, and yep, as you say, if we can fold whatever we think we need into the main README (or a companion README) that has the advantage that we don't have to separately maintain two "tracks" of documentation (one for the archive and one for the repository itself). As you say, sounds like something we can think about as we get nearer to "publishing."

@santiagohermo regarding finding someone to test the repository, yes, I have someone in mind and will work on assigning them!